C-Bus C-Touch Programming Reference 5000CT Series 1 2 3 4 5
Intelligent Building Series C-Touch Programming Reference Table of Contents Section......................................................................................................Page 1.0 2.0 3.0 4.0 Product Range ............................................................................... 3 Description ..................................................................................... 3 Menu Notation................................................................................
Intelligent Building Series C-Touch Programming Reference 10.6 Evaluating User Requirements .......................................................... 56 11.0 Tutorial ......................................................................................... 58 11.1 11.2 11.3 11.4 Storyboard ......................................................................................... 59 Scene Design .................................................................................... 62 Example Scenes........
Intelligent Building Series C-Touch Programming Reference 1.0 Product Range The products included in this range are: BS5000CT BB5000CT BP5000CT SC5000CT 5035TX C-Bus Touchscreen, Monochrome, Stainless Steel C-Bus Touchscreen, Monochrome, Brass C-Bus Touchscreen, Monochrome, Powder Coated Steel C-Bus Touchscreen, Monochrome, Slim Line C-Touch (or Scene Master) hand held infrared remote control included with all of above 2.
Intelligent Building Series C-Touch Programming Reference 4.0 Definitions The following definitions are useful in discussing the C-Touch unit: Term Definition Load A load is an electrical device connected to mains voltage via a C-Bus output unit. Most loads are lights, but may be any device such as sprinklers, AC Power points, heaters, projection screen motors etc. A scene is defined as the combination of loads distributed in various control zones with different levels.
Intelligent Building Series C-Touch Programming Reference In the hexadecimal system, in exactly the same way, once the number “F” (the last digit) is reached a symbol must be placed in the next column (the “sixteens” column). A comparison between the two is shown below. Decimal Number Hexadecimal Number 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 0 1 2 3 4 5 6 7 8 9 A B C D E F 10 Decimal jumps to 10’s column Hex jumps to 16’s column For a full list, please refer to the help file. 4.
Intelligent Building Series C-Touch Programming Reference There are two ways of creating tags for use with a C-Touch project: • Using the C-Bus Project Manager – see C-Bus documentation for details.
Intelligent Building Series C-Touch Programming Reference Because there are 256 discrete levels (0 to 255) but only 101 different percentages (0 to 100), not all levels have a unique corresponding percentage. If a group level is being set as a percent, there will be some levels which cannot be set. For example, the levels 6,7 and 8 all convert to 3% as shown in the table below: Level Gives % 6 7 8 3.137 3.529 3.
Intelligent Building Series C-Touch Programming Reference 5.0 Configuring the Software The C-Touch configuration software is a Windows™ application that uses a graphical representation of various controls and objects associated with the programming of the C-Touch unit. Upon startup, a screen similar to that below is displayed: Before a project can be created this software can be configured to operate in a way most convenient to the user. This section describes these preliminary configuration settings. 5.
Intelligent Building Series C-Touch Programming Reference Connections This tab contains the settings for connections between the PC and both the CTouch unit and the C-Bus network. The options for connection to C-Bus are via a serial connection and via a C-Gate server on any IP address. If an old style PC interface is being used, (version 2.x) then the “Version 1 PC Interface” tick box from the “Other” tab of the Options | Program Options menu selection should be ticked.
Intelligent Building Series C-Touch Programming Reference The syntax is as follows: [path]\CTouch.
Intelligent Building Series C-Touch Programming Reference Examples: To start the Guide Example used in this Programmer’s Guide and open a connection to the C-Bus network on COM1 the following command line would be used: C:\Clipsal\C-Touch\CTouch.exe "C:\Clipsal\C-Touch\Projects\Examples \Example 13 – Guide Example\GuideExample.xml" /COM1 This may be included in the shortcut for the program in the start menu. Another example, using C-Gate running on IP address 1.2.3.4 would be: C:\Touchscreen\CTouch.
Intelligent Building Series C-Touch Programming Reference 6.0 Using the Software Before using the software some initial concepts need to be understood. The design of the project is performed by using the left mouse button to select components, placing them on a page and configuring them to operate as desired. This is the “design mode” of the software. Note: Don’t use the C-Touch software while using the C-Bus installation software project manager or browser.
Intelligent Building Series C-Touch Programming Reference 7.0 Creating a C-Touch Project A C-Touch project is comprised of a set of pages with various controls on each page. How the project works determines the user experience. 7.1 Starting a Project The project may be started in three basic ways from the File menu. These options are New Project, Project Wizard and Open. 7.1.1 New Blank Project When the C-Touch Configuration program first starts, a blank project is created automatically.
Intelligent Building Series C-Touch Programming Reference Screen Orientation The options for screen orientation either a normal or inverted orientation. The design of the touch screen display provides superior viewing contrast within a range of angles as shown below. If the unit is to be mounted at eye level or above then the normal orientation, denoted in the orientation drop down box as “IR Window at Top” is best.
Intelligent Building Series C-Touch Programming Reference Installer Information The installer information involves details of the installer such as the: • Name • Company • Address • City • State • Postcode • Country • Phone • Mobile • Fax • E-mail • Web Site Options The options tab includes three main areas, Start Up Details, Time-out Details and Key Press Sounds. In addition a night light can be enabled or disabled with a tick box.
Intelligent Building Series C-Touch Programming Reference 7.2 Using Pages The basic building block of a project is a page, which is populated with various controls and objects. It is possible to work with the project at the page level without consideration of what is on the pages. The sections below describe various options for working at the page level. 7.2.
Intelligent Building Series C-Touch Programming Reference 7.3 Adding Components Once pages are defined, the actual components for each page must be created and placed on the page. The functionality of each component is then assigned so that the desired behaviour for the project is realised. Many components can be selected from the tool bar at the top of the screen. The tool bar is illustrated below. 7.3.1 Text Component This component displays a single line of text. The font can be set.
Intelligent Building Series C-Touch Programming Reference A Slider Component is used to set or show the precise level of a Group. A Slider consists of a border, background, slot, thumb (the bit that slides up and down) and tick marks. 7.3.6 Percentage Indicators A Percentage Indicator Component is used to show the precise level of a group as a percentage of full load. It has a border and background and can have its text font set. 7.3.
Intelligent Building Series C-Touch Programming Reference 7.4 Component Properties Once a component is created, the properties relevant to that object may be changed from their defaults to achieve a certain effect. 7.4.1 Visible Properties The visible properties (physical appearance) of a particular Component may be changed by either: • Double clicking on the component, or • Selecting the component (by clicking on it) and choosing the Edit | Component Properties menu item.
Intelligent Building Series C-Touch Programming Reference Border Tab This tab allows the border style, line style and the border width to be entered. The border styles can be selected from a list that includes: • Rectangle • Round rectangle • Raised • Lowered • Circle (ellipse) • Triangle (right) • Triangle (left) • Triangle (up) • Triangle (down) The line styles can be: • None. The line style can be set to none to make it transparent.
Intelligent Building Series C-Touch Programming Reference Background Tab This tab allows the appearance of the background of the component to be entered. The style and colour can be selected. The list of styles is as follows: • None. The background can be set to none to make it transparent. • Solid • Light shaded • Medium shaded • Dark shaded As before, the colour can be selected from a palette or specified by hue, saturation and luminance, which will be reduced to a shade of gray.
Intelligent Building Series C-Touch Programming Reference Images Tab This tab allows the selection of both the image(s) which are displayed on a button component and the image alignment (top, left, centre etc). The following shows the tab. An image may be displayed by ticking the Show Image check box. One of the standard images may be selected, or active and inactive bitmap images from any source may be used via the Custom button.
Intelligent Building Series C-Touch Programming Reference Clock Tab The clock tab allows the properties of a clock component to be set. This tab is illustrated below. The time group allows a selection of all or none of: • Show time • Show seconds • 24 hour The day group allows a selection of show day of week and/or show full name.
Intelligent Building Series C-Touch Programming Reference Slider Tab The appearance of a slider component can be modified within a wide range of possibilities. The slider tab (illustrated below) has three main groups; Slot, Thumb and Tick Marks. The slot group contains selections for slot shape, border width, width of the slider, border colour and background colour.
Intelligent Building Series C-Touch Programming Reference The border width in this case refers to the border of the thumb itself and can range from one to five [1..5] pixels. The thumb width can vary from five to twenty [5..20] pixels and the length can vary from ten to fifty [10..50] pixels. The tick marks group contains entries for the style, the width and the length of the tick marks.
Intelligent Building Series C-Touch Programming Reference Monitor Tab A monitor component is like a gauge that can display the value of some variable. A monitor can be used to display temperature, light levels or voltage. A temperature component properties tab is illustrated below: Since a C-Bus unit must furnish these values, the unit address of the unit, between 00 and FE must be supplied. The readings displayed can be updated at different intervals.
Intelligent Building Series 7.4.2 C-Touch Programming Reference Page Links When a component is activated, it can cause another page to be displayed. The page link tab is illustrated below.
Intelligent Building Series C-Touch Programming Reference Alternatively, an existing component can be linked to a page. This is done by: • Select the component • Double click on the component OR select the Button Properties item from the Edit menu • Select the Link tab page • Select the destination page from the list Special Functions When a component is activated, it can cause some “Special Functions” to be executed. A Special Function needs to be added to the component to bring this about.
Intelligent Building Series C-Touch Programming Reference A special function is added by the following: • Select the component • double click the component OR choose Edit | Button Properties from the menu • Select the Link tab page • Select the desired special function from the list 7.4.3 Infrared Remote Control The C-Touch unit can be operated by an Infrared remote control. This may be the one that comes with the unit, or any remote control that uses NEC codes.
Intelligent Building Series C-Touch Programming Reference The remote tab for the component, as shown, can be used to set the properties of the component: An association between a Component and a remote control key is set in the following way: • Display the properties of the component by double clicking on it • Select the Remote Control tab from the Component Properties dialogue box • Select the IR Remote Control Enabled check box.
Intelligent Building Series 7.4.4 C-Touch Programming Reference C-Bus Properties To change the C-Bus Properties of a particular Component, either: • Double click on the component, or • Select the component (by clicking on it) and select the Edit | Component Properties menu item • Select the C-Bus tab.
Intelligent Building Series C-Touch Programming Reference 7.5 Manipulating Components Having selected a component and the associated properties, each component can be manipulated and grouped with other components visually. In addition, components can be copied and deleted. The following sections deal with these operations. 7.5.1 Selection Before a Component can be manipulated, it must be selected by clicking on it with the left mouse button.
Intelligent Building Series 7.5.4 C-Touch Programming Reference Painting Format Once the format of a Component has been set to achieve some kind of visual effect, the format itself may be copied to other similar Components in the project. This is called “Painting Format”. The Painting Format operation is performed by first selecting and copying a component with the desired formatting.
Intelligent Building Series C-Touch Programming Reference To match the size of several components, the component that the others must match is selected (this is called the “Primary Selection”). Then the other component(s) are selected. The height, width or both can be set by either clicking the “Size” speed buttons on the tool bar or selecting Edit | Size and choosing one of Height, Width or Both. Some components have a minimum size.
Intelligent Building Series 7.5.9 C-Touch Programming Reference Undo The undo function takes the project back to a previous state. If operations are carried out (creating a component, moving a component resizing etc) then by successive application of the undo toolbar button (shown below) or the Edit | Undo Edit menu item the project can be returned to the state before those operations were performed. A maximum of six operations can be “undone”.
Intelligent Building Series C-Touch Programming Reference 7.6 Schedules A schedule is used whenever something has to occur at a particular time. This can be an event that occurs only once or something that is repeated time and time again. The unit has a list of things to do, and every second it checks whether one of those things should be done at this particular time. Every schedule creates a new entry in that list. Generally, schedules are independent of each other.
Intelligent Building Series C-Touch Programming Reference The Schedule Manager is shown below. A new schedule is created with the Add button. When this is done, the Schedule Editor dialogue box appears. If an existing schedule is to be modified, the schedule is selected and one of Delete, Edit or Duplicate is selected. If the Duplicate function is chosen an exact replica of the selected schedule is created and the schedule details must be changed to create a unique schedule. 7.6.
Intelligent Building Series C-Touch Programming Reference Each Schedule has several main properties: • A name/description • An enabling Group Address • A time • A day • An event Description The description for the Schedule is set on the Properties tab. The description should be something that will be meaningful when seen in a list. Enable A schedule can be turned on or off. If the schedule is turned on, the schedule proceeds as programmed. If it is off, the schedule is ignored.
Intelligent Building Series C-Touch Programming Reference Day The day(s) that the Schedule is to occur is set on the Day tab. By default, the Schedule is set to occur every day. There are two ways of selecting the day. More or less detail can be displayed by clicking on the more or less button.
Intelligent Building Series • • • • C-Touch Programming Reference If the Schedule is to be executed on particular days of the month, then the required days are selected. There are buttons at the bottom to allow: • all days to be selected quickly, • all days to be cleared quickly, • the first week of the month etc. to be selected. If the Schedule is to be executed in particular months, then the required months are selected.
Intelligent Building Series C-Touch Programming Reference Note that the Schedules displayed will not be executed unless the Scheduler is running and the schedules are enabled. It can also be set running by clicking on the Edit | Schedule | Run Scheduler item in the menu. (The last two illustrated, KitchenDinnerWeekWinterON and OFF are disabled because the date of 30/10/2001 does not fall within the winter months in the Southern Hemisphere where this schedule was designed).
Intelligent Building Series C-Touch Programming Reference 7.7 Scenes A scene is used to control several loads at once in a coordinated action. Since each scene may be associated with one or more activities, the C-Touch software contains a scene editor to create scenes and a scene manager to manipulate scenes created with the scene editor. The sections which follow describe these two utilities, which are fully integrated into the C-Touch configuration software. 7.7.
Intelligent Building Series C-Touch Programming Reference references. An illustration of such a case would be where scene 1 triggers scene 2 which in turn triggers scene 1. These scenes will trigger each other indefinitely. If there are circular references, an alert message is produced. 7.7.2 Scene Editor The Scene Editor allows the user to edit scenes in a project. The Scene Editor is accessed in one of three ways: via the Scene Manager, by the ADD button or the Edit button.
Intelligent Building Series C-Touch Programming Reference Triggering A particular Group Address and Level may be used to trigger a scene. The triggering Group Address and level are entered in the Scene Editor by selection from the proffered options. If the Scene does not need to be triggered from a remote unit, this is left as “unused”. Typically, a particular Group Address on the Enable Application (number CB hex) will enable the Schedule when it is at 100%.
Intelligent Building Series C-Touch Programming Reference 7.8 Saving the Project The project is saved either clicking on the Save button of the tool bar, or by selecting File | Save. The project can be saved with a different file name by selecting File | Save As and entering the desired name. If the project is being saved for the first time, or being saved with a different file name, a prompt to enter a file name is displayed.
Intelligent Building Series C-Touch Programming Reference 7.9 Testing the Project The completed project consists of a great number of pages, controls, interactions and displays. Good practice dictates that the project be verified before downloading to minimise the amount of iteration required in creating a project. This section deals with the testing of the project. 7.9.1 Check Project A check of the project can be performed by selecting File | Check Project from the menu.
Intelligent Building Series Item Meaning Error 203 Add a page link to the The project displays the date, but has no provision date setting page. for setting the date. Error 204 The project has no provision for setting the contrast. The project has no provision for setting the backlight. A page can not be reached from the start-up page or from the time-out page. Two or more components on a page have the same IR code. Only one will be activated. One component is completely hidden by another.
Intelligent Building Series C-Touch Programming Reference If the component is a button, the state of the button will change (if C-Bus is connected, the command will be executed). A more complete simulation mode can also be set by selecting the item from the Options | Simulation Mode, or by pressing CTRL + S. The key combination CTRL + S is used to get out of Simulation Mode since the menus are hidden in simulation mode.
Intelligent Building Series C-Touch Programming Reference The option to save the data as CSV values is for ease of import into a spreadsheet program if required. 7.9.5 Connecting to C-Bus The C-Touch Configuration Software can control C-Bus if it is connected. This is used mainly for testing purposes, but can also be used for establishing the current group address levels when setting scenes. The unit is connected to C-Bus with the Options | Connect to C-Bus menu selection.
Intelligent Building Series C-Touch Programming Reference 8.0 Downloading to C-Touch Once the project is complete, all pages and links are in place and they have been tested using the simulation mode the project should be downloaded to the C-Touch unit for final checks and commissioning. 8.1 Downloading There are two types of data that can be downloaded to the C-Touch Unit. The first (and most common) requirement is to download the user configuration data (a project).
Intelligent Building Series C-Touch Programming Reference If the continuation option is chosen, the C-Touch software runs through every page and every component in the project. The display shows a “fast forward” through the project as it carries out the checks. Finally a file is created in the project directory called “resources.txt”.
Intelligent Building Series C-Touch Programming Reference 8.2 File Structure Ultimately, the C-Touch Configuration Software generates a file which is downloaded to a C-Touch unit. The format of the images downloaded for each component depend upon the type of component.
Intelligent Building Series C-Touch Programming Reference 9.0 Uploading From C-Touch The C-Touch unit can upload a currently displayed screen to the C-Touch software. This feature scans the display of the unit and creates an image on the computer screen. This is useful for capturing unusual occurrences or unexpected behaviours for later display or e-mail to CIS support personnel. The C-Touch unit must first be connected to the computer with a serial cable using Transfer | Connect to Touchscreen.
Intelligent Building Series C-Touch Programming Reference 10.0 Good Design Practices Good projects have a number of common features regardless of the design of the projects. The number of fonts and components is held to the minimum, memory utilisation is carefully controlled, the ergonomics of the pages and their navigation is natural and intuitive and finally, good documentation and a user training session complete a successful project. 10.
Intelligent Building Series C-Touch Programming Reference The C-Touch software offers the options of password protected screens and this is a particularly useful feature for time setting pages and other utilities. If the time on the unit can be changed by anyone then the schedules programmed into the unit cannot work as designed. 10.5 Memory Management The C-Touch Configuration Software generates a file which is downloaded to a C-Touch unit.
Intelligent Building Series C-Touch Programming Reference 10.6 Evaluating User Requirements Prior to commencement the installer should visit the customer with a laptop and show examples of completed projects and rough out the requirements freehand on the forms provided in the appendix. The success of a C-Touch project is best judged on the basis of how well it meets the requirements of the user. These requirements must be captured with the customer before and during the design of an actual project.
Intelligent Building Series C-Touch Programming Reference 10.6.5 Initial Implementation Once the overall requirements have been recorded, the project should be designed at the office and brought back when complete. 10.6.6 Simulation The simulation mode can be used to demonstrate how the project will look when installed.
Intelligent Building Series C-Touch Programming Reference 11.0 Tutorial Now that we have seen what C-Touch could do in general terms, let’s have a look at how you would do some of these things in an example situation. (The project for this tutorial is in the Guide Example project). C-Bus is installed in the house shown below. We want to have control of lighting in some main areas, scene setting throughout the house and scheduling for other functions.
Intelligent Building Series C-Touch Programming Reference 11.
Intelligent Building Series C-Touch Programming Reference The first page in the project is a “Master Menu” page that points to three other pages; the “Family” page, the “Meals” page and the “Ancillary” page. Each button has an arrow drawn to the relevant page showing the transfer of control. This page, which is the default page for the project shows the date and time at the bottom in an area akin to a footer on a printed page.
Intelligent Building Series C-Touch Programming Reference Note that in all these layouts there are three possible locations for navigation buttons, the last one being lower right. This is typically to be used to return control to an intermediate level page such as the Images and Controls page. As a rule a project should not contain more than three “levels” of pages. By providing only three positions for return buttons this rule is enforced by the page layout.
Intelligent Building Series C-Touch Programming Reference 11.2 Scene Design The scenes in a project may be used to create a mood by ramping lights up or down at predetermined rates. Example scenes were shown in Section 6.8 previously. Another use for scenes is to enable several loads to be controlled at once for the purposes of scheduling. The scenes shown in the example below are used in conjunction with the schedule section which follows.
Intelligent Building Series C-Touch Programming Reference number of outputs to be switched at once and these are ideal for scene control. Some example scenes are illustrated on the pages which follow. (These scenes also relate to the example in the Tutorial section). 11.3.1 Welcome Home Scene The welcome home scene is initiated by entry to the house. All main access lighting to common living areas is activated. Outside lights are switched off after a suitable period of time.
Intelligent Building Series C-Touch Programming Reference house during breaks in the movie but maintain the mood. Some people prefer low level lighting in the actual room the movie is being shown in, this depends upon the size of the television or projection screen and viewer preferences in combination. The display shows the scene in the process of being edited.
Intelligent Building Series C-Touch Programming Reference 11.4 Schedule Design The schedule design is performed using the template in the appendix. Here is an example of a schedule: Each schedule is given a “Name” which describes the purpose of the schedule. The “Load” is from the C-Bus project. A schedule is a moment in time when some event is to occur.
Intelligent Building Series C-Touch Programming Reference The kitchen lights, for example are to be turned on for breakfast, lunch and dinner and so each event has a schedule entry. The schedule in this case is different according to whether it is a weekday or the weekend. Some of the schedules are only in effect during the winter months when it is darker later in the morning and earlier in the evening.
Intelligent Building Series C-Touch Programming Reference The page for the family room is shown here. Note that you can actually cut out the relevant portion of the drawing and use it in a C-Touch layout if convenient. The drawing cutout is imported as a bitmap and then controls and components are overlaid. Here is the page for the meals area. The meals area has one light over the table.
Intelligent Building Series C-Touch Programming Reference 11.4.1 Utility and Setting Pages The C-Touch firmware comes with several preset pages. The utility pages contain calibration, diagnostics, startup and cleaning pages. The setting pages allow the time, date, contrast and backlight to be adjusted. Our example project shows a C-Touch page that can access all these preset pages. The utility page is password protected to prevent tampering.
Intelligent Building Series C-Touch Programming Reference Once we enter the appropriate password we get a page like this in our sample project: These are the four basic utility functions, calibration, diagnostics, startup and cleaning. The calibration page is used to ensure accurate registration between finger pushes on the page and the displayed pages. Normally the calibration page is not required.
Intelligent Building Series C-Touch Programming Reference The final utility page is the cleaning page which disables C-Touch temporarily so that the unit can be cleaned without turning loads on and off inadvertently. The page looks like this: The setting pages allow you to set the date, time and overall appearance of C-Touch.
Intelligent Building Series C-Touch Programming Reference Selecting the time function produces this page: Selecting the date function produces this page: The contrast adjustment page looks like this: © Copyright 2002 Clipsal Integrated Systems Pty Ltd Page 71
Intelligent Building Series C-Touch Programming Reference The backlight page looks like this: © Copyright 2002 Clipsal Integrated Systems Pty Ltd Page 72
Intelligent Building Series C-Touch Programming Reference 12.0 Other Information In addition to the written documentation and this programmer’s guide there is the help system provided with the software, the Clipsal Integrated Systems website and the “tip of the day”. These are described in this section. 12.1 Help File The C-Touch configuration software comes equipped with an online help system and extensive cross referencing.
Intelligent Building Series C-Touch Programming Reference 12.4 What’s New The C-Touch Configuration Software has many new features introduced with each new release. The What’s New dialogue is designed to introduce a few of these ideas to you. The What’s New dialogue box will be displayed when you start the software. You can also display it by selecting the Help | What’s New item in the Menu. The Show on Startup check-box allows you to set whether you want it displayed each time the software starts. 13.
Intelligent Building Series C-Touch Programming Reference Scene Pro-Forma Scene Name © Copyright 2002 Load(s) Level(%) Clipsal Integrated Systems Pty Ltd Rate(sec) Page 75
Intelligent Building Series C-Touch Programming Reference Scheduling Pro-Forma Name/Load or Scene/Enabled By AM PM 00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 00 Enter the name of the load in the Load column and draw a black line with a felt marker to block out the times that loads are to start and stop.
Intelligent Building Series C-Touch Programming Reference Page Template © Copyright 2002 Clipsal Integrated Systems Pty Ltd Page 77
