Introduction to C-Bus Toolkit Software C-Bus Products Training Course

Transcription

1 Introduction to C-Bus Toolkit Software C-Bus Products Training Course Training Guide 1250SM0803R10/09 Retain for future use.

2 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 HAZARD CATEGORIES AND SPECIAL SYMBOLS Read these instructions carefully and look at the equipment to become familiar with the device before trying to install, operate, service, or maintain it. The following special messages may appear throughout this bulletin or on the equipment to warn of potential hazards or to call attention to information that clarifies or simplifies a procedure. The addition of either symbol to a Danger or Warning safety label indicates that an electrical hazard exists which will result in personal injury if the instructions are not followed. This is the safety alert symbol. It is used to alert you to potential personal injury hazards. Obey all safety messages that follow this symbol to avoid possible injury or death. Danger indicates an immediately hazardous situation which, if not avoided, will result in death or serious injury. Warning indicates a potentially hazardous situation which, if not avoided, can result in death or serious injury. Caution indicates a potentially hazardous situation which, if not avoided, can result in minor or moderate injury. Caution, used without the safety alert symbol, indicates a potentially hazardous situation which, if not avoided, can result in property damage or improper operation. NOTE: Provides additional information to clarify or simplify a procedure. ii 2009 Schneider Electric. All Rights Reserved.

3 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course PLEASE NOTE FCC CLASS B Electrical equipment should be installed, operated, serviced, and maintained only by qualified personnel. This document is not intended as an instruction manual for untrained persons. No responsibility is assumed by Schneider Electric for any consequences arising out of the use of this manual. This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) this device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. Consult the dealer or an experienced radio/tv technician for help. Changes or modifications to this device that are not expressly approved by Schneider Electric could void the user's authority to operate this equipment Schneider Electric. All Rights Reserved. iii

4 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 CONTENTS Hazard Categories and Special Symbols...ii Please Note...iii FCC Class B...iii Safety Precautions...1 Scope...2 Learning Outcomes...2 PC Requirements...2 Installing the Toolkit Software...3 Obtaining C-Bus Toolkit...3 Install C-Bus Toolkit...3 Starting the Program...5 Left Section of Initial Display...5 Right Section of Initial Display...6 Main Menus...7 File Menu...7 Connect to Local Project Repository...7 Connect to a Remote Project Repository...7 Disconnect Project Repository...8 Set Default Interface...8 Preferences...9 Restore Projects...9 Backup Projects...9 Exit...9 Preferences Dialog Box...9 Projects Menu...16 Add Project...16 Delete Project...16 Find C-Bus Networks...16 Close All Networks...16 Repair Projects...17 Refresh...17 Import Projects from V Export Projects to V Go Menu...17 Help Menu...18 Using the Project Manager...19 Project Hierarchy...19 Working Window...20 Functional Icons...20 Project Node...21 Project Sub-Nodes...23 Network Node...23 Topology Node...25 Network Sub-Nodes...27 Application Log Toolbar...27 Applications Node...27 Overview...27 Application Types...29 Units Node...31 Units in Database Window...32 Units on Network Window...34 iv 2009 Schneider Electric. All Rights Reserved.

5 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Example: Scanning a New C-Bus Network...37 C-Gate Server Software...41 Overview of C-Gate...41 C-Gate Operation...41 C-Gate Functions...41 Support and Training Schneider Electric. All Rights Reserved. v

6 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 vi 2009 Schneider Electric. All Rights Reserved.

7 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course SAFETY PRECAUTIONS Carefully read and follow the safety precautions below before attempting to install or maintain electrical equipment. HAZARD OF ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH Apply appropriate personal protective equipment (PPE) and follow safe electrical work practices. See NFPA 70E. This equipment must be installed and serviced by qualified electrical personnel. Turn off all electrical power supplying this equipment before working on or inside the equipment. Always use a properly rated voltage sensing device to confirm that power is off. Replace all devices, doors, and covers before turning on power to this equipment. Failure to follow these instructions will result in death or serious injury Schneider Electric. All Rights Reserved. 1

8 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 SCOPE LEARNING OUTCOMES PC REQUIREMENTS This manual teaches the basic skills needed to use the C-Bus Toolkit software for configuring networks and C-Bus units. This manual covers the following items: How to obtain the Toolkit software and PC requirements The Toolkit interface Use of the main Toolkit menus, dialog boxes, and C-Gate interface Types of network and unit addresses By the end of this module, you should have an understanding of the following: C-Bus project and network structure Role of the C-Gate software Toolkit software options Different types of C-Bus Addresses Basic network management procedures Before installing the C-Bus tm Toolkit software, ensure that your PC meets the minimum configuration requirements listed below. Table 1: Acceptable PC Configurations for Using C-Bus Toolkit Component Minimum Configuration Preferred Configuration Operating System Windows XP Professional Windows XP Professional RAM 256 MB of RAM 512 MB RAM (or greater) Processor Pentium 4, 1 GHz (or equivalent) Pentium 4, 2 GHz Core 2 Duo processor, E6300 or better Hard Drive 4 GB 40 GB Free Space (Hard 250 MB 5 GB Drive) Display, Color 800 x 600 resolution 1024 x 768 resolution or better Peripherals Mouse One of the following: Serial COM port Ethernet adapter USB port and USB to RS-232 converter One of the following: CD-ROM drive USB drive Network Adapter 10 Mbps or better (optional) Other Software Anti-virus Schneider Electric. All Rights Reserved.

9 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course INSTALLING THE TOOLKIT SOFTWARE Obtaining C-Bus Toolkit Download the installation package from the Support > Software Downloads section of the Square D Lighting Control web site: Install C-Bus Toolkit The C-Bus installation file is used to install or upgrade C-Bus Toolkit. During installation of C-Bus Toolkit, C-Gate Server is also installed. C-Gate Server is required for the following: Using C-Bus Toolkit and other C-Bus software Monitoring a C-Bus network Refer to the "C-Gate Server Software" section for more information. 1. Double-click the C-Bus Toolkit zip file. The zip file opens, showing it's contents. 2. Double-click CBusToolkit_#_#_#_Full.exe, where # is the version number of C-Bus Toolkit. The C-Bus Toolkit Setup Wizard opens, as shown below. 3. Click the Next button. The Select Destination Location section of the Wizard opens, which allows you to enter the installation folder for C-Bus Toolkit and C-Gate Server. 4. Click the Next button. The License Agreement section of the Wizard opens. 5. Select the I accept the agreement option Schneider Electric. All Rights Reserved. 3

10 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/ Click the Next button. The Select Start Menu Folder section of the Wizard opens, which allows you to enter the location of the Start menu shortcuts. 7. Click the Next button. The Select Additional Tasks section of the Wizard opens. 8. Verify that the Create C-Bus Toolkit desktop icon, the Create C-Gate desktop icon, and the Install Example and Home projects options are checked. 9. Click the Next button. The Ready to Install section of the Wizard opens. 10. Click the Install button. C-Bus Toolkit and C-Gate Server is installed. 11. Click the Finish button to close the Installation Wizard Schneider Electric. All Rights Reserved.

11 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course STARTING THE PROGRAM Depending on your installation and computer settings, you can quickly start the C-Bus Toolkit program in one of three ways. 1. Double-click on the Toolkit shortcut icon on your desktop. 2. Select the Windows "Start" button, navigate to the C-Bus Toolkit folder (it is installed in a folder called Clipsal), and select the C-Bus Toolkit icon. The default C-Bus Toolkit folder location is shown in the figure, "Starting Toolkit from the Windows 'Start' Menu." 3. Open the Start menu to see if the Toolkit icon is on it. If so, double-click on it (see the figure, "Toolkit Icon on 'Start' Menu"). Figure 1: Toolkit Icon on Start Menu 4. When Toolkit starts, you will see a display with two main sections, as shown in the figure, "Initial C-Bus Toolkit Display." Left Section of Initial Display On the left is the Project Manager area. This area uses a tree structure to list all the projects and their components. The projects and their components are shown or hidden when you click on the + (open/expand) or (close/contract) symbols next to the folders. By selecting one of the component folders, you can work with the elements of that project Schneider Electric. All Rights Reserved. 5

12 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Figure 2: Initial C-Bus Toolkit Display Above the Project Manager tree are the main Toolkit menus ( File, Projects, Go, and Help ). These menus are described in the section, Main Menus. Right Section of Initial Display On the right is the Welcome to C-Bus window, with some brief instructions to help you start working with Toolkit. At the top of the Welcome window is a set of functional icons, such as Add Project, Scan Network, and so on (see the figure, Initial C-Bus Toolkit Screen ). These icons are described in the section, Welcome Window Functional Icons. NOTE: You can hide and show the Project Manager area by clicking on the center of the divider Schneider Electric. All Rights Reserved.

13 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course MAIN MENUS File Menu The File Menu provides options for connecting to networks, managing project files, setting C-Bus Toolkit preferences, and installing USB drivers. Connect to Local Project Repository Connect to a Remote Project Repository This option connects to the Toolkit database and to any C-Bus networks connected to the local PC. Toolkit automatically makes this connection when you start it. Use this option to connect to a database and C-Bus networks associated with Toolkit, HomeGate, HomeSpeak, or Schedule Plus on a PC in a remote location or on a server. The steps below outline the process. 1. Disconnect the local connection by selecting Disconnect Project Repository. The content in the Project Manager and Welcome window will disappear 2. Select the Connect to Remote Project Repository option. The C-Gate Site dialog box will open (see the figure, Connecting to a Remote Project ) Schneider Electric. All Rights Reserved. 7

14 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/ Enter a Site Name and the IP Address or the Host Name of the remote database and C-Bus network. NOTE: The Site Name does not have to be the site s actual name, it is just a name you use to identify the site. Disconnect Project Repository Set Default Interface Use this option to disconnect from the local or remote database and C-Bus network so that you can connect to another location (a different database and/or physical location). NOTE: When you select this option, the content in the Project Manager and Welcome window will disappear. This option opens the Default Interface dialog box, so you can specify how you will connect to a local C-Bus network via a Serial (PC Interface (PCI)) connection or via an Ethernet connection (Ethernet Network Interface (CN)). If you select PCI, you must also select a serial (COM) port address. If you select CNI, you must provide an IP address and port number. Figure 3: Setting the Default Local Interface Schneider Electric. All Rights Reserved.

15 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Preferences Restore Projects Backup Projects Exit Preferences Dialog Box The Preferences option opens a dialog box with the following six settings tabs, which are used to configure basic Toolkit operations (see the figure, Preferences Dialog Box ). Features Behavior Unit Dialogs Advanced Compatibility Display Formats These options are illustrated and described in the subsection, Preferences Dialog Box, at the end of this section. This option reloads projects that have been backed up/saved on your computer to the project database on your local PC. If the project is still in the database when you restore from a file on the computer, Toolkit will ask what you want to do. Use this option to back up all projects in the database on your local PC. The backup file will have the project name, the date, and the time it was backed up, and it will have the suffix.cbz. If you do not specify a folder for the file, it will be placed in My Documents. Quit Toolkit. The more complex options and settings in the Preferences dialog box are described in tables, but many of the options are fully described on the tab. Also see the Toolkit Help feature for more information on many options. NOTE: The default tab settings are shown in the figures. If there are no settings, it indicates there is no default. Any recommendations are described in the figures, text, or tables. Features Options The Features tab is at the front when the Preferences dialog box opens. Its options are described in the table, Features Tab Schneider Electric. All Rights Reserved. 9

16 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Figure 4: The Features Tab in the Preferences Dialog Box Table 2: Description of Features Tab Settings Group Option Action Network Activity Network Activity Miscellaneous Live Levels Application Log Remember Project Manager State When this box is checked, Toolkit displays the correct values of all Group Addresses in real time. It also enables the Scene Capture functionality in the Scene Manager. When this box is checked, Toolkit records events that it sees on the C-Bus network. Events are stored in a separate Application Log under each Application in an open network. The logs are erased when you exit Toolkit software, unless you specify that they should be saved (see the section, Saving Application Logs ). When this box is checked, the Project Manager will have the same appearance as the last time Toolkit was open Schneider Electric. All Rights Reserved.

17 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Behaviour Options Two types of options are in the Behaviour tab Automatically Launch and Shut Down Server (see the figure Behaviour Tabs ). Because Shut Down Server will close the C-Gate application, it can affect network operations. We recommend setting this option to Ask. Refer to the section, C-Gate Server, and the table, Behaviour Tab, for more information on this option. Figure 5: Behaviour Tab in the Preferences Dialog Box Table 3: Description of Behaviour Tab Settings Group Option Action Automatically Launch Automatically Launch Shut Down Server New Unit Key Function Never Always Ask When this box is checked and a new unit is added to the Database window, Toolkit will automatically open the unit s Toolkit interface ( dialog ). When this box is checked and a Key Function is selected in the unit s interface, Toolkit will automatically launch the related Function dialog. For example, when an input unit is being configured with Dimmer or Timer Functions, any additional options will be presented automatically. Never shut down the C-Gate server when you exit Toolkit. Not recommended unless you are managing an installation with Powerlink. Always shut down the C-Gate server when you exit Toolkit. Not recommended unless the only C-Gate associated program you use is Toolkit (see the section C-Gate Server ). NOTE: The C-Gate server acts as a command interface for a number of C-Bus programs, such as Toolkit, HomeGate, and SchedulePlus. If you select Always shut down the C-Gate server, it can disrupt network operations if you are using other network programs besides Toolkit. Ask if you want to shut down the C-Gate server when you exit Toolkit. We recommend selecting this option Schneider Electric. All Rights Reserved. 11

18 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Unit Dialogs Options The Unit Dialog tab contains parameters for controlling how unit configuration dialog boxes (dialogs) are launched and how temperature is expressed in units of measure. Figure 6: Unit Dialogs Tab Table 4: Description of Behaviour Tab Settings Group Option Action Dialog Mode Temperature Unit Sort Mode Applications Groups Levels Simple Advanced Last Used Celsius Fahrenheit Tag Name Address The Simple radio button, when selected, opens the unit configuration dialog box to display in its simple form. This means generally that the tabbed part of the dialog box is not visible. The Advanced radio button, when selected, opens the unit configuration dialog box to display in its advanced form. This means generally that the tabbed part of the dialog box is visible. The Last Used radio button, when selected, opens the unit configuration dialog box to display as it was before the it was previously closed. By default, the dialog mode selection is the Last Used mode. The Temperature Measurement Unit drop down list allows you to set all unit configuration dialog boxes to display Fahrenheit or Celsius. By default, temperature units are displayed in Celsius. The Sort Mode group allows you to select how Applications, Groups, and Levels are sorted. You can select to sort by the tag name or address Schneider Electric. All Rights Reserved.

19 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Advanced Options The options in the Advanced tab allow you to enable an Error Reporting log, Reset suppressed dialogs, and set the size of C-Gate Memory. The table, Description of Advanced Tab Settings, explains these options. NOTE: This Error Reporting-Feedback Log is to help diagnose software problems and would be sent to Clipsal Integrated Systems (CIS). It is different from the Applications Log that you would use to track network operations (see the sections, Features Options and Saving Application Logs ). Figure 7: Advanced Tab in the Preferences Dialog Box Table 5: Description of Advanced Tab Settings Group Option Action Error Reporting Error Reporting Reset "Don't ask me again" C-Gate Memory Feedback Log Maximum Size (Log) Reset Minimum Maximum Log commands and errors to a file that can be sent to Clipsal Integrated Systems (CIS) for diagnosis. A log size of 100 kb is appropriate for dial-up users. Broadband users may choose 500 kb to provide more diagnostic information. Resets all dialog boxes turned off with the "Don't ask me again" option. Use these options to set the limits of C-Gate memory. We recommend checking the C-Gate memory settings when you first install Toolkit. The Minimum should be 32 and the Maximum should be 192, as shown in the illustration of the Advanced tab Schneider Electric. All Rights Reserved. 13

20 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Compatibility Options Integration Options: Check this box to allow the creation of user-defined C-Bus applications. Legacy Support: Check this box to allow the creation of legacy C-Bus applications. Figure 8: Compatibility Tab in the Preferences Dialog Box Table 6: Description of Compatibility Tab Settings Group Option Action Integration Options Legacy Support Allow creation of User Defined C-Bus Applications Allow creation of legacy C-Bus Applications. Check this box to allow the creation of user-defined C-Bus applications. Check this box to allow the creation of legacy C-Bus applications Schneider Electric. All Rights Reserved.

21 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Display Formats Options This tab allows you to select how the network units Tag Names are described in their Toolkit interfaces. We recommend using the last option, Format Tag Names with Values including Hexadecimal. Recall that units do not store alpha-numeric data, so if you scan a network and do not have a link to the database, you will not be able to see the units Tag Names. You will be able to see the Hexadecimal values. Figure 9: Display Formats Tab in the Preferences Dialog Box Table 7: Description of Display Formats Tab Settings Group Option Action Global C-Bus Address Display Options Use Standard Tag Names Format Tag Names with Values Format Tag Names with Values Including Hexadecimal Tag Name Preview Standard Tag Names lists all groups created by the user in the Toolkit projects in alphabetical order. Format Tag Names with Values lists all groups in numerical order with the group address numbers first and then the Tag names created by the user in the Toolkit projects. Format Tag Names with Values Including Hexadecimal lists all groups in numerical order with the group address numbers first, then the hexadecimal values of the group address, and then the Tag names created by the user in the Toolkit projects. The Tag Name Preview is an example of the global C-Bus address based on the option selected Schneider Electric. All Rights Reserved. 15

22 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Projects Menu Figure 10: Projects Menu Add Project This option will create a new empty C-Bus project. You will be asked if you want to add a C-Bus network to the new project. If you answer yes, the Add Project dialog box will open and you will be prompted to provide a name for the network, and to specify the details of the Network connection. Figure 11: Add Project Dialog Box Delete Project Find C-Bus Networks Close All Networks As its name implies, this option deletes the selected project. Use this to find every interface that is connected to your PC, such as a PC Interface (PCI) or Ethernet Network Interface (CN or CNI). When the software detects an interface, Toolkit will allow you to scan the local C-Bus network. Closes all open C-Bus networks. NOTE: All open networks will be closed, not just a project that is selected Schneider Electric. All Rights Reserved.

23 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Repair Projects Refresh Import Projects from V2 Export Projects to V2 The Repair project function repairs the structure of the project within C-Bus Toolkit. The Repair Project button is used to repair the file structure of the C-Bus Toolkit project. The file structure is XML based. If content brackets are missing, this can render the file corrupted. Refreshes (updates) all views in the Projects tree and network windows. Use this option to import projects from a C-Bus V2 software installation which exists in the default location on the same PC as C-Bus Toolkit. Imported projects are converted to the current Toolkit format. Use this option to export projects from Toolkit, but in a format compatible with the C-Bus V2 Installation Software. Projects are typically exported to C:\Clipsal\CBUSV2\PROJECTS on your PC. Go Menu Figure 12: Go Menu When you select an option in the Go menu, you will move to that area of the current project. Option Project Node Network Node Applications Node Units Node Description The Project node provides control over and information about: C-Bus connectivity to C-Bus Toolkit Applications and groups utilised for controlling C-Bus units in the network. Unit programming details at the logical level Unit programming details at the physical network level The C-Bus network topology The Network node contains programming information about each of the network's applications and devices. The Applications node contains all C-Bus applications which have been defined for a specific Network node. The Units node is the work space where you can design a network as well as program a physical one Schneider Electric. All Rights Reserved. 17

24 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Help Menu Figure 13: Help Menu Option Contents Clipsal Website Check for New Version Report a Problem What's New About Description Use this option to open the Help file which includes information about C-Bus Toolkit and C-Bus products. Use this option to open a web browser to the Clipsal web site. Use this option to check for and install updates to C-Bus Toolkit. Use this option to send an to support whenever C-Bus Toolkit does not perform as expected. Keep in mind that this does not open support ticket. Use this option to view information about the new features and updates in your version of C-Bus Toolkit. Use this option to see which version of C-Bus Toolkit and C-Gate server you are using. An Internet-based C-Bus Forum provides another valuable source of information. The forum is free-of-charge, and it allows you to draw on the experience of other C-Bus programmers around the world, 24 hours a day. The web address is If you require C-Bus network product support, refer to the section, Support and Training, for Technical Supports s and web site addresses Schneider Electric. All Rights Reserved.

25 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course USING THE PROJECT MANAGER The Project Manager is the area on the left side of the Toolkit window where you can manage and quickly access all the components of a C-Bus Project. It is organized into a tree-like structure that contains all the Projects that are available for selection (see the figure, Project Manager Area and Expanded Project ). NOTE: The Project Manager can be shown or hidden by clicking on the divider between the Project Manager area and the working window on the right side. Figure 14: Project Manager Area and Expanded Project Project Hierarchy Each project has a top-level folder (e.g., EXAMPLE, HOME) and subfolders or nodes (e.g., Network (42), Topology). The tree structure is expanded and contracted by clicking on the plus (+) or minus ( ) symbol next to a folder. The top-level folder is described in the section, Project Node. The figure, Project Manager Area and Expanded Project, shows the nested folders or nodes of the EXAMPLE project three networks and Topology. These are described in the section, Project Sub-Nodes. Clicking on the plus (+) symbol next to a network folder expands it to show the network-related nodes Application Log, Applications, and Units (see the figure, Expanded Network Folder ). These nodes are described in the section, Network Sub-Nodes. If a node at this level has sub-nodes, they are described in the section describing the level above (e.g., Applications sub-nodes are described in the Applications section) Schneider Electric. All Rights Reserved. 19

26 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Figure 15: Expanded Network Folder Working Window Functional Icons Whenever you select a folder or subfolder in the Project Manager, the window on the right (the working window ) will change to reflect the level of the selected folder. In the figure, Project Manager Area and Expanded Project, the top-level folder of the EXAMPLE project was selected, so the working window was referred to as the Project window. In the figure, Expanded Network Folder, Network (254)-Local was selected, so the working window is referred to as the Network window. Both figures show a set of functional icons at the top of the working window these will change according to the level of a project that is selected (Project level, Network level) and the actions being performed. For example, the icons in the Project window include Rename Project, Copy Project, and Add Network; the icons in the Network window include Delete Network, Edit Network, and Open Network. The icons are a quick way to open the task-related dialog boxes you will use to configure and manage your networks and units. You can access many of the same dialog boxes by right-clicking in the working window. NOTE: The icons at the top of the working window will vary according to the level of folder that has been selected and sometimes the task that is being performed. Some icons will be grayed out if you are not connected to a live network or if you are at a certain stage of a task. Functional icons are described in more detail in the following sections Schneider Electric. All Rights Reserved.

27 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course PROJECT NODE When you select the project level folder in the Project Manager, the working window changes to the Project window (see the figure, Project Level Window ). The Project window lists the networks and number of units in each, and has a set of functional icons at the top. Figure 16: Project Level Window These functional icons (see the figure, Functional Icons in the Project Window ) perform many of the the same functions as the options in the Project menu (see the section, Main Menus ). When you click on an icon, you will initiate the tasks listed in the table, Description of Icons in the Project Window. Figure 17: Functional Icons in the Project Window Table 8: Description of Icons in the Project Window Icon Rename Project Copy Project Delete Project Function Prompts you to enter a new name for the selected Project. Creates a copy of the selected Project. You are prompted to type a name. Deletes the selected Project Schneider Electric. All Rights Reserved. 21

28 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Open All Networks Close All Networks Backup Project Document Project Add Network Delete Network Edit Network Open Network Close Network Copy Tags Readdress DLT Labels Set Project All Attempts to open all Networks in the selected Project. The relevant Networks must be connected to the PC via C-Bus for this to be successful. Closes all open C-Bus networks. NOTE: All open networks will be closed, not just a the one that is selected. Creates a backup archive of the selected Project in My Documents unless you specify another location. The backup file will have the project name, the date, and the time it was backed up, and it will have the suffix.cbz. Analyzes and logs the configuration of a Project, saving the file to results.html, which it places in My Documents\Clipsal\Software. Adds a new network to the current Project. You will be prompted to enter a name and network connection details. As its name implies, this option deletes the selected project. Allows you to change the name and connection details of the selected Network. Attempts to open the selected Network. The Network must be connected to the PC via C-Bus for this to be successful. Closes the connection to the selected network. This function imports Groups and their Tags (names) into the selected Network. You are prompted to select a source network from the same Project. Group Tags in the selected network will also change to those used in the source network. Prompts you to select a new (unused) Network Address for the selected network. Allows you to create and edit textual and graphical labels that are associated with particular Groups. These can be transferred to DLT input units, where they become customized labels on the DLT screen. Saves the Project name to all units that have been scanned into the network using the Scan Network icon in the Units on Network window Schneider Electric. All Rights Reserved.

29 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course PROJECT SUB-NODES Network Node A Project can contain up to 255 networks. Each network contains an Application Log and Applications and Units nodes (see the figure, Network Level Window ). Toolkit automatically generates these nodes when you create a network. When a network-level folder (node) is selected, the working window becomes the Network window (see the figure, Network Level Window ). In addition to the functional icons at the top of the Network window, the Network window provides a quick summary of the network and its power status. Included are the network s impedance, the number of units in the network, the amount of current drawn and available, and whether the current is adequate. NOTE: To generate an accurate Current Supply, you must define whether or not the output device has a power supply. A unit without a power supply is indicated by adding (P) to the end of the catalog number entered in the Catalog Number (db) text box on the Unit Identification tab of the selected unit's Edit dialog box. As shown in the figure, Network (254) Local does not have enough current, because it requires 2 ma more than is available. In other words, a unit needs to be removed or a C-Bus network Power Supply needs to be added. Figure 18: Network Level Window 2009 Schneider Electric. All Rights Reserved. 23

30 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Functional icons at the top of the Network window are illustrated in the figure, Functional Icons in the Network Window and described in the table, Description of Icons in the Network Window. Figure 19: Functional Icons in the Network Window Table 9: Description of Icons in the Network Window Icon Delete Network Edit Network Open Network Close Network Copy Tags Readdress DLT Labels Set Project All Function Deletes the selected Network. Allows you to change the name and connection details of the selected network. Attempts to open the selected Network. The network must be connected to the PC via C-Bus for this to be successful. Closes the connection to the selected network. This function imports Groups and their Tags (names) into the selected Network. You are prompted to select a source network from the same Project. Group Tags in the selected network will also change to those used in the source network. Prompts you to select a new (unused) Network Address for the selected network. Allows you to create and edit textual and graphical labels that are associated with particular Groups. These can be transferred to DLT input units where they are displayed as customized labels. Saves the Project name to all units that have been scanned into the network using the Scan Network icon in the Units on Network window Schneider Electric. All Rights Reserved.

31 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Topology Node When the Topology node is selected, you will see an illustration of the project s topology in the Topology window (see the figure, Topology Window ). For example, the three networks in the EXAMPLE project are organized in a combination Star-Daisy Chain. The illustration also includes the address of each network connected to a Network Bridge. The Topology-level functional icons are described in the table, Description of Icons in the Topology Window. Figure 20: Expanded Network Folder Table 10: Description of Icons in the Topology Window Icon Print Copy Image Function Prints the C-Bus topology map to the default printer. Copies the C-Bus topology map to the clipboard as a raster (bitmap) image. It can then be pasted into other software applications Schneider Electric. All Rights Reserved. 25

32 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/ Schneider Electric. All Rights Reserved.

33 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course NETWORK SUB-NODES Application Log Toolbar Each network folder contains an Application Log. When the Application Log option is enabled in Preferences (see the section, File Menu ), Toolkit records C-Bus events occurring on that C-Bus network. The log is erased when you exit Toolkit unless you indicate that you want to save it by selecting the Save Log icon at the top of the Application Log window (see the figure, Functional Icons in the Application Log Window ). The Application Log toolbar icons are described in the table, Description of Icons in the Application Log Window ). NOTE: The Application Log only collects data when C-Bus Toolkit is connected to the network. Figure 21: Functional Icons in the Application Log Window Table 11: Description of Icons in the Application Log Window Icon Clear Log Pause/Resu me Filter (On/Off) Save Log Edit Application Edit Group Edit Unit Function Clears the current log. Stops generating and displaying events until you select the icon again (Resume). Filter allows you to specify that events will be logged only for selected Applications, Groups, and Units. To stop filtering, click on the icon again. Saves a file to the My Documents folder on the computer. The file will be named ApplicationLog_projectname_networkname_date_time.log. Opens the Edit Application dialog box, which allows you to edit the selected application's Application description in the application log. Opens the Edit Group dialog box, which allows you to edit the selected application's Group description in the application log. Opens the Edit Unit dialog box, which allows you to edit the selected application's Originating Unit description in the application log. Applications Node Overview The C-Bus building automation Applications (e.g., Lighting, Heating, Telephony) are at the heart of the C-Bus architecture. Each Application has been defined to suit a specific building-automation activity and has the following capabilities or characteristics: 2009 Schneider Electric. All Rights Reserved. 27

34 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 controls or integrates with electrical-load controls, directly or indirectly provides a suitable messaging protocol transmits application-specific building automation information between units or to other peripherals Application Types and Their Addresses C-Bus incorporates the different building-automation operations into Application types, each with dedicated C-Bus messaging and units. The main Application types include the following: Lighting application groups node Heating application groups node Telephony application node Enable Control application groups (also known as enable network variables) node Trigger Control groups node Figure 22: Main Applications Node and Window Applications Folder Hierarchy The Applications folder contains a sub-folder for each Application Address in a network (see the figure, Main Applications Node and Window ). Each individual Application and its network Address are listed in the Applications window, along with icons that allow you to add, edit, or delete a selected Application (see the table, Description of Icons in Main Applications Window ). Table 12: Description of Icons in Main Applications Window Icon Add Application to Network Edit Application Delete Application Function Adds a new Application to the current Network. You will be prompted to enter an Application Address, Name, and Description. Allows you to view the Application Address or change its name and description. Deletes the selected Application Schneider Electric. All Rights Reserved.

35 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Application Types When an individual Application folder is selected, a corresponding Application type window is displayed in the working window with a list of the groups that have been created. For example, one of the most frequently used Application types is Lighting. If the Lighting Application is selected, the Lighting Groups window appears (see the figure, Lighting Groups Node and Window ). Icons at the top of the Lighting Groups window are specific to this window (see the table, Description of Icons in the Lighting Groups Window ). Figure 23: Lighting Groups Node and Window Table 13: Description of Icons in the Lighting Groups Window Icon Edit Application Delete Application Add Group Edit Group Delete Group Set Group ON Set Group OFF Modify Last Unit to Set DLT Labels Function Allows you to view the Application Address or change its name and description. Deletes the selected Application. Adds a new Group to the selected Application, in this case, Lighting. You will be prompted to enter a Group Address and Description. Allows you to change the Group s description or turn the Group ON or OFF. Deletes the selected Group. Sets the level or selector of the selected Group Address to a value of 255. This function only works when the Network is open, a C-Bus Network is connected and Scan Network has been performed in the Units on Network window. Note that a selector may be referred to by the Toolkit software as a value or action selector. Sets the level or selector of the selected Group Address to a value of 000. This function only works when the Network is open, a C-Bus Network is connected and Scan Network has been performed in the Units on Network window. Allows you to edit the last unit to use the selected Group Address (if known). Allows you to assign a textual or iconic (pictorial) label to the Group Address. This can be transferred to Dynamic Labeling Technology (DLT) input units Schneider Electric. All Rights Reserved. 29

36 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Group Addresses Many individual Group Addresses (such as Kitchen, Dining Room, or Group 12) can be created in an Application such as Lighting. Each Group Address will be displayed in the main Application type window, and each Group Address has its own subfolder. For an example, we return to the Lighting Application (see the figure, Group Address Node, Window, and Icons ). Figure 24: Group Address Node. Window, and Icons When the Group 0 node is selected, a split window is displayed in the working window. One half lists the Group Levels, the other lists the Group Dependencies. Functional icons at the top of the Group window are described in the table, Description of Icons in the Group (Details) Window. Table 14: Description of Icons in the Group (Details) Window Icon Edit Group Delete Group Set Group On Set Group Off Modify Last Unit to Set Function Allows you to change the Group s Description (Tag). Deletes the selected Group. Sets the level or selector of the selected Group Address to a value of 255. This function only works when the Network is open, a C-Bus Network is connected and Scan Network has been performed in the Units on Network window. Note that a selector may be referred to by the Toolkit software as a value or action selector. Sets the level or selector of the selected Group Address to a value of 000. This function only works when the Network is open, a C-Bus Network is connected and Scan Network has been performed in the Units on Network window. Allows you to edit the last unit to use the selected Group Address (if known) Schneider Electric. All Rights Reserved.

37 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course DLT Labels Add Level Edit Level Delete Level Set Level Allows you to assign a textual or iconic (pictorial) label to the Group Address. This can be sent transferred to Dynamic Labelling Technology (DLT) input units. Allows you to add a level to a Lighting type group. Allows you to edit a level to a Lighting type group. Allows you to delete a level to a Lighting type group. Allows you to set a level to a Lighting type group. Units Node The Units node provides links to the project database and to the network s physical C-Bus units. When the Units node is selected, the working window will show the Units in Database window, the Units on Network window, or both, depending on the status of the network and database (see the figure, Units Windows ). For example, if a network is closed (i.e., the PC that runs Toolkit is not connected to the physical network or you have just created a network or project but have not scanned in the units), you will only see the Units in Database window. When Toolkit is connected to a physical network (temporary or permanent), the working window will be split, and the Units on Network window will also be displayed below the Units in Database window. (If both are displayed, you can close either of them.) NOTE: The Units on Network window will not show the physical C-Bus units until they have been scanned into the network. Units that have been scanned into the Units on Network window will not appear in the Units in Database window until they have been transferred into the database. Figure 25: Units Windows 2009 Schneider Electric. All Rights Reserved. 31

38 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Units in Database Window The two Units windows are used for a number of network management tasks, such as adding C-Bus units to a project and configuring the units. When you click on the name of the unit in the working window, its configuration interface opens. The windows also display useful information about each unit, including its name, serial number, location, Tag, Group assignments and levels, and so on. For example, before the units have been installed at the project site, you can use them to create a temporary network and configure the physical units, as described in the Trainee Resources manual. Alternately, you could build a virtual project in the Units in Database window, adding and configuring the C-Bus units before they have been installed or connected to Toolkit. These configurations can then be transferred to the physical units once you have established a network connection. The Units in Database window shows the C-Bus units that have been scanned into the network window and transferred into the database (see the figure, Units in Database Window and Icons ), or the virtual units that have been created in the database window. The database stores the network s configuration information, so it is critical to keep it synchronized with the configuration of the physical units. In the event the units are configured virtually (i.e., by adding units that are not physically connected to the PC and Toolkit), the configuration must be transferred to the physical units. The benefits of an up-to-date database include the following: With a project database, you can customize the project when the network is closed (not connected). It speeds up configuration of new or replacement units. It is quicker and easier to work in the database and transfer the information to the units than it is to work directly with units on the network. NOTE: Current information about the physical units must be placed in the database by transferring it from the Units on Network window. It is not automatically updated. (Clarify further and/or add Caution?) Schneider Electric. All Rights Reserved.

39 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Figure 26: Units in Database Window and Icons Functional icons at the top of the Units in Database window are listed in the table, Description of Icons in the Units in Database Window. Table 15: Description of Icons in the Units in Database Window Icon Add Unit Edit Unit Delete Unit Convert Units Copy Unit Readdress Get Serials Transfer to Network Global Programming Document Database Function Adds a new unit to the database. You are prompted to select a unit from a list of known unit types. You can then enter a Serial Number, Unit Address, and Name (Tag) for the unit. Presents you with a panel allowing you to configure the unit s Application Address, Group Address, and many other parameters (depending on the unit type). Deletes a unit from the database. Allows the conversion of configuration information stored on a unit in the database to a similar unit type. For example, you can convert unit information from an 8 key Neo to an 8 key Reflection in order to match the physical unit listed in the Units on Network window. Make a copy of the selected unit. Prompts you to select a new Unit Address for the selected unit. Transfers serial numbers of all units on the Network to units of the same type and Unit Address in the Database. Transfers the configuration data of the selected unit in the database to a unit of the same type with the same Unit Address on the Network. Configures unit parameters within the project database across applicable units. Creates a file listing each unit in the database, including its Part Name, Unit Type, and Addresses (Unit, Application, Area and Group).The data is written in ASCII Comma Separated Value (CSV) format and suitable for use in a spreadsheet Schneider Electric. All Rights Reserved. 33

40 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/2009 Reinstall Transfers the configuration data from a unit on the network (with a Unit Address of 255) to a selected unit of the same type in the database. It is not necessary to use the Scan Network function in the Units on Network window first. Units on Network Window When the network is open (i.e., the PC that runs Toolkit is connected to a live, physical network), the Units on Network window is displayed under the Units in Database window (see the figure, Units on Network Window and Icons ). In this window, you can scan a physical C-Bus installation (if it is connected to your PC) and view the status of the units on the C-Bus network. You also can use this window for unit configuration. Figure 27: Units on Network Window and Icons Units on Network icons are listed in the table, Description of Icons in the Units on Network Window. Table 16: Description of Icons in the Units on Network Window Icon Scan Network Scan New Edit Unit Readdress Function Performs a complete scan of a connected C-Bus network. If multiple units have the same Unit Address, you will be asked if you want to resolve the Unit Address conflict (unravel them). Scanned units are loaded into the Units on Network window. Performs a short scan of a connected C-Bus network to search for a new unit (a unit with a Unit Address that is not present in the Units on Network window). Units with a duplicate Unit Address will not be detected. Clicking the down-arrow on the Scan Network button reveals the Scan New function. Allows the editing of unit details within the Units on Network window. Prompts you to select a new Unit Address for the selected unit Schneider Electric. All Rights Reserved.

41 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course Serial Number Readdressing Readdress to Match Database Add/Transfer to Database All to Database Advanced transfer Unravel Ping Make network Match Serials Unit to Database Uses serial numbers to find matching logical and physical units, then converts the unit addresses of the physical units to the logical unit addresses. Clicking the down-arrow on the Readdress button reveals the Serial Number Readdressing function. Allows the readdressing of units within a C-Bus network or database. Clicking the down-arrow on the Readdress button reveals the Serial Number Readdressing function. Adds the selected unit on the network to the database (only if the database has no unit with the same Unit Address or serial number). Transfers the configuration data of all units on the network to units of the same type with the same Unit Address in the database. Any units not present in the Database will be added. Clicking the down-arrow on the Add/Transfer to Database button reveals the All to Database function. Facilitates adding units defined in the Units on Network window as well as the configuration information to the C-Bus Toolkit database. Clicking the down-arrow on the Add/Transfer to Database button reveals the Advanced Transfer function. Checks the C-Bus network for multiple units with the same Unit Address. If duplicates are found you will be asked if you want to resolve the conflict (unravel them). Checks the C-Bus network to see if the units present in Units on Network exist. Creates, configures, and opens a new network corresponding to the other side of the selected bridge or gateway. Requires a bridge or gateway to use. Changes the Unit Addresses of units on the network to the Unit Addresses of units in the database with the same serial numbers. You are prompted with a list of units so you can select which Addresses to change. Transfers the configuration data of the selected unit to a unit of the same type with the same Unit Address in the database Schneider Electric. All Rights Reserved. 35

42 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/ Schneider Electric. All Rights Reserved.

43 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course EXAMPLE: SCANNING A NEW C-BUS NETWORK The following example demonstrates how to scan a new C-Bus Network. NOTE: Scanning requires connection to physical C-Bus units, as described in the following steps. 1. If necessary, open Toolkit. 2. Select Set Default Interface from the File menu. The Default Interface dialog box will open for you to designate the interface that the PC will use to communicate with the C-Bus network. 3. Use the Interface Type drop-down list to select one of the following options, then click on the OK button: Serial (PCI), if the network connection is through a PC Interface (PCI). Also select a COM port from the Address drop-down list. IP Address (CNI), if the network connection is through an Ethernet Network Interface. Also enter an IP address and port. NOTE: Before a new CNI can be used to communicate with a C-Bus Network, it must be programmed with an IP Address using the Lantronix Device Installer software. This is available from the downloads section at the following web address: Schneider Electric. All Rights Reserved. 37

44 Introduction to C-Bus Toolkit Software 1250SM0803R10/09 C-Bus Products Training Course 10/ Click on the Find C-Bus Networks icon at the top of the Welcome window. The software will use the PCI or Ethernet Network Interface (CN) selected in Step 3 to search for a C-Bus network. When Toolkit finds a C-Bus network, it retrieves the Project Name from the PCI or CN and displays the Open Project dialog box (see the figure, Open Project Dialog Box ). The default Project Name for new C-Bus units is CLIPSAL. You are then presented with the following three options: Open the CLIPSAL project (using the Project Name retrieved) Select from a list of existing projects Create a Project with a different name. 5. For this example, select Create a Project with a different name. The Add Project dialog box will open so you can enter a new Project Name. 6. Type EXAMPLE, then click on the OK button. The software will continue to scan the C-Bus Network, identifying C-Bus units and adding them to the Units on Network window of the specified Project Schneider Electric. All Rights Reserved.

45 1250SM0803R10/09 Introduction to C-Bus Toolkit Software 10/2009 C-Bus Products Training Course If Toolkit finds any Unit Address conflicts (multiple units with the same Unit Address), it will ask if you want to unravel the units. (Unravel means that Toolkit automatically re-assigns Unit Addresses to resolve the conflicts.). If this occurs, choose Yes to unravel. 7. When Toolkit indicates that the scan is complete, transfer the unit information in the Network window to the Database window by clicking on the All to Database icon. This will open the Transfer Units dialog box Schneider Electric. All Rights Reserved. 39