CommandFusion Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Clipsal CBus Plugin ======

<WRAP center round important 60%>
Please note that this plugin is a **THIRD PARTY TOOL** is not created by CommandFusion and we offer no official support for it. It is a **FREE plugin** maintained by members of the CommandFusion community. **We can not guarantee the plugin will always be in working order and bug free.** We acknowledge that this documentation is incomplete, it is maintained by the developer of the plugin who has other business and personal commitments,.
</WRAP>


<WRAP center round important 60%>
Please be patient this is a work in progress over next few weeks complete with screen shots etc, so please don't edit till I removed this line, also additions put in over next few weeks will not be done in order, I will being putting instructions on and then tweak.
</WRAP>
===== Before You Start =====

You must have some basic knowledge of Clipsal Cbus,[[http://www2.clipsal.com/cis/technical/downloads/c-bus_toolkit|Cbus Toolkit,]]and Commandfusion. 


You will require the following items:

SOFTWARE

1. [[http://www2.clipsal.com/cis/technical/downloads/commissioning_tools#Diagnosticutility|Cbus Diagnostic Utility which can be found here.]]

2. [[http://www2.clipsal.com/cis/technical/downloads/c-bus_toolkit|Cbus Toolkit which can be found here.]] 

3. Your Cbus back up project if you did not create it, this will be a file ending with ".cbz" (not having this is not the end of the world, as can upload your cbus project using Cbus toolkit, you will just be missing the text names associated with the unit addresses.)

4. [[https://github.com/CommandFusion/C-Bus-guiDesigner-Plugin|Cbus Plugin which can be found here.]] 

HARDWARE

There are numerous ways to achieve cbus to ip interfacing and everyone has a personal preference, thus there no need to supply a complete list of every scenario possible in here, including different models of global caches units etc, this is a guide for new users. Below are 3 popular scenarios, for the "how to do" example I will be using scenario (C) which is the 5500PC cbus interface in conjunction with a IP2SL-P Global cache unit.


(A) [[http://www2.clipsal.com/cis/__data/page/428/5500PC%20data%20sheet2.pdf|Cbus PC interface 5500PC.]] This cbus interface unit will allow multiple user connections,it needs to be used in conjunction with a TCP/IP to serial unit such as a a[[http://www.commandfusion.com/lanbridge.html#downloads|CommandFusion's LAN Bridge  (up to 25 TCP connections, and UDP support).]] which has RS232 interface,(see data sheet for limitations of multiple connections) and connection is required between the 5500PC and [[http://www.commandfusion.com/lanbridge.html#downloads|CommandsFusions LAN Bridge.]] via a RS232 serial lead. 

or

(B) [[http://www2.clipsal.com/cis/__data/page/428/5500CN%20data%20sheet2.pdf|Cbus CNI interface 5500CN.]] This cbus interface unit requires no RS232 interfacing and connects direct to ethernet, but will only allow one user connection at a time.
Although if used in conjunction with a[[http://www.commandfusion.com/lanbridge.html#downloads|CommandFusion's LAN Bridge  (up to 25 TCP connections, and UDP support).]] it will allow [[software:system-commander:tcp-socket-multiplexing|TCP Socket Multiplexing]] then you will be able to connect multiple devices to systems that allow only a single connection at a time over TCP.

or

(C) [[http://www2.clipsal.com/cis/__data/page/428/5500PC%20data%20sheet2.pdf|Cbus PC interface 5500PC.]] This cbus interface unit will allow multiple user connections, it needs to be used in conjunction with a TCP/IP to serial unit such as a Global Cache IP2SL (see the iTach data sheet for limitations of multiple connections on their devices) and connection is required between the 5500PC and TCP/IP to serial via a RS232 serial lead.
===== Cbus Setup =====

Please note: each time you make a change to the cbus project via the PC interface or use a third party app to control cbus, the PC interface settings will change, if you intend to use in conjunction with Commandfusion suggestion would be to use another interface sole used for these otherwise you will have to change settings each time. There is a command which you can add in as initialisation from commandfusion to change the settings for the PC interface to be correct each time you start iviewer but for the example below I have shown the manual setup.

CBUS 5500PC SETUP

Before you begin you must have the [[http://www2.clipsal.com/cis/__data/page/428/5500PC%20data%20sheet2.pdf|Cbus PC interface 5500PC]] set to network address 254 this will be set through [[http://www2.clipsal.com/cis/technical/downloads/c-bus_toolkit|Cbus Toolkit which can be found here.]]. 
Plug your PC via serial lead into the [[http://www2.clipsal.com/cis/__data/page/428/5500PC%20data%20sheet2.pdf|Cbus PC interface 5500PC.]] Then run [[http://www2.clipsal.com/cis/technical/downloads/commissioning_tools#Diagnosticutility|Cbus Diagnostic Utility.]] Once open go to "OPTIONS" then another window will open then select "PROGRAM OPTIONS", then check box which is your method of connect then click "OK'. In this example I am using serial and com7 as per below screenshot.

{{ :software:third-party-tools:guidesigner-plugins:program_options.png?direct |}}

Now to connect to the [[http://www2.clipsal.com/cis/__data/page/428/5500PC%20data%20sheet2.pdf|Cbus PC interface 5500PC]] to make the relevant setting changes to allow CF to talk to the CBUS network go to "CONNECT",a drop down box will appear then select "CONNECT TO CBUS", you will see a tick next to the "CONNECT TO CBUS" once you have clicked on it.A list of messages will scroll down the screen and finish with a window with some PC interface details as per below screen shot. Once pop up window has appeared click "OK".

{{ :software:third-party-tools:guidesigner-plugins:address.png?direct |}}

Once the popup window disappears, scroll down to the middle buttons and click on "SET MODE", and make the settings as per below screenshot. OPTION 1 must have "CONNECT, CHECKSUM, SMART" ticked, OPTION 2 has no bearing on the CF plugin if selected or not, please read cbus documentation or contact installer if you require these to be selected or not. OPTION 3 requires EXSTAT only selected, the other option are for your personal preference for your cbus system.

{{ :software:third-party-tools:guidesigner-plugins:checkbox.png?direct |}}
===== Commandfusion Systems and Cbus Toolbox =====

**CREATE YOUR SYSTEMS**

Once you have created a project you need to create two systems, the first will be "cbus" this is the name of the cbus.js script, the system must be exactly as per the script name and it is case sensitive. Note: The startup macro will be placed in later and described later. The second is "broadcast". Inside the "broadcast" feedback will have to be created the regex will be "cbus:..:..:..;"

**Important note: the system names and feedback names must be named as per screen shots**

**System "cbus"**

{{ :software:third-party-tools:guidesigner-plugins:system_cbus.png |}}

**System "broadcast"**

{{ :software:third-party-tools:guidesigner-plugins:system_broadcast.png |}}

**System "broadcast" feedback** note: regex will be "cbus:..:..:..;"

{{ :software:third-party-tools:guidesigner-plugins:system_feedback.png |}}

**CBUS TOOL BOX**

Once the systems are created, open the cbus toolbox as per below screen shot. Once toolbox is open we will proceed to find your cbus file.

{{ :software:third-party-tools:guidesigner-plugins:open_tool_box.png |}}

To find your cbus file, notice the the C-Bus XML file tab on the above screenshot, click on the browse button, follow the tree as per below screenshot and find your cbus project.

{{ :software:third-party-tools:guidesigner-plugins:cbus_file_location.png |}}

===== Commandfusion Adding the Project =====

**CBUS PROJECT INTO COMMANDFUSION**

Before you add your cbus project into commandfusion there are some steps to follow and understand,

{{ :software:third-party-tools:guidesigner-plugins:toolbox_description.png?200 |}}

**System**

First step is to click on the reload button to the right of system, this will refresh any systems you have added. once refreshed click on the drop down box and select the "cbus" system.

**Lighting and Trigger base joins**

These determine the joins that will automatically be elected once you add your project, these joins will include analogue, serial and digital joins, for this example we have chosen to use 5000 for the individual lights and the 6000 will be for the scenes, joins are very important to how the JS was written and triggers lighting not only for the lighting feedback so make sure you choose empty joins. 

**Level Display**

This drop down gives the option to how the level is display in serial text if used.

__Cbus__

levels range from 0-255, being 0 is off and 255 is on, if light is dimmed to halfway it will indicate 127.

__Percentage__

level will be indicated as a percentage 0% is off 100% in on, if a light is dimmed to halfway it will indicate as 50%.

**Project**

This is the final step before you click the "ADD" button, as you can see from below screenshot there are some tick boxes, if you open the tree you will see your cbus project name in this example it is called "BSHORT", then under this will be you network (254), the next step down in the tree will be lighting (56) and trigger control (202). 

//NOTE: Depending on your cbus project you may see other options as enable control (203) or other networks with other address such (243), currently the cbus module only allows network (254) and also only allows for lighting (56) and trigger control (202) under this network. Other options may be offered in further releases.//

{{ :software:third-party-tools:guidesigner-plugins:project_tree.png?200 |}}

If you tick the highest box in the tree this will select everything below it in the tree to add, however if you only want to add part of you cbus project you can open up all the boxes including down to the point of individual lights or scenes for selection.

{{ :software:third-party-tools:guidesigner-plugins:project_tree_individual.png?200 |}} 

**ADDING THE PROJECT AND OPTIONS**

Now you have decided upon you options and how much you want to add, the next step is to click on "ADD", once you click on "ADD", a task complete box will show, once you click "OK" the items will be added into the "cbus" system, we are now ready to add commands to buttons.

{{ :software:third-party-tools:guidesigner-plugins:add.png |}}
}


===== Adding The Commands =====

**SYSTEM COMMAND TYPES**

As per the below screenshots you will notice 4 different types of commands: Level, Toggle, Ramp and Scenes, you will notice that the cbus names and addresses are the same for ramp and toggle, this will be explained further.

**Level**

This is a command to be send out as a get or refresh command, the (56) command is the individual light level command and the (202) is the scene commands, this should be placed in a macro and placed into the cbus system startup command macro as per screen shots, further to this you can add it into your main js to run the macro upon wake up.   

{{ :software:third-party-tools:guidesigner-plugins:system_manager_1.png?200 |}}

Below is the macro with the delays required

{{ :software:third-party-tools:guidesigner-plugins:int_macro.png? 400 |}}

Below is where to add the macro into the system for startup

{{ :software:third-party-tools:guidesigner-plugins:int_cbus.png |}}

**Toggle and Ramp**

These commands are actually tied together in the cbus JS and are required to be placed onto a button and a slider to work, even if a slider is not required in you gui, this is explained further.

{{ :software:third-party-tools:guidesigner-plugins:system_manager_4.png?200 |}}

{{ :software:third-party-tools:guidesigner-plugins:system_manager_2.png?200 |}}

**Scenes**

This command is used to trigger scenes that you have created in your cbus project toolkit, this command is not required for the cbus js to work, it is up to yourself if you use this.

{{ :software:third-party-tools:guidesigner-plugins:system_manager_3.png?200 |}}

**ADDING THE COMMANDS TO BUTTONS**

**Individual lights**

To make a light work, you will require a single button (on/off state) and a slider, the way the JS module is written you will require both the toggle and the ramp of the system for it to work. Even if you do not require the slider as the light you are trying to control is just on / off, a slider will be required, this can be placed on a cache page in your gui project and not ever brought to screen.

Buttons

Below I have shown the toggle command property, notice the (56,1)in the JavaScript box, we are only interested in the 1. This is the address we need for feedback and control.

{{ :software:third-party-tools:guidesigner-plugins:toggle_command_properties.png |}}

Next create your preferred button and drag the command into the button or the other option is to open the button properties and select your command.

NOTE: when selecting command make sure you use the "toggle command" not the "ramp" command.

Once you have selected the toggle lighting command, the next step is to do the __digital join__, in this example we will use digital join 5001. The reason we have used 5001 is as follows:

The 5000 part of the address is the base address join we selected earlier in __Commandfusion Adding the Project - Lighting and Trigger base joins__ prior to adding the cbus to cbus system in commandfusion.

The 0001 portion of the address is the address of the cbus light we are going to control, the address is shown in the above screen shot of the system command property.

{{ :software:third-party-tools:guidesigner-plugins:toggle_button_properties.png |}}

Slider

Below I have shown the ramp command property, notice the (56,1)in the JavaScript box, we are only interested in the 1. This is the address we need for feedback and control, also notice that it is the same address as the toggle command property.

{{ :software:third-party-tools:guidesigner-plugins:ramp_command_properties.png |}}

Next create your preferred slider, //Note:do not drag the command into the slider as it will automatically place the command into "on-drag" in the sliders properties//. For sliders we require the command to be in the "On Release" tab. Open the "On Release" tab and select your preferred command, in this example it will be "-ramp- L1 PORCH LIGHTS -cbus56- -js-"

NOTE: when selecting command make sure you use the "ramp command" not the "toggle" command.

Once you have selected the ramp lighting command, the next step is to do the __analogue join__, and "Simulate Feedback" must be selected. In this example we will use digital join 5001. The reason we have used 5001 is as follows:

The 5000 part of the address is the base address join we selected earlier in __Commandfusion Adding the Project - Lighting and Trigger base joins__ prior to adding the cbus to cbus system in commandfusion.

The 0001 portion of the address is the address of the cbus light we are going to control, the address is shown in the above screen shot of the system command property.

{{ :software:third-party-tools:guidesigner-plugins:ramp_button_properties.png |}}

Lighting Level

This is not actually required to make the cbus module module work, it is only a text of the light level. Earlier on in the __Commandfusion Adding the Project - Level and Display__ we selected the type of level shown, be it unit between 0-255 or percentage 0%-100%, which ever was selected will be the way it is shown with the light level on your device.

{{ :software:third-party-tools:guidesigner-plugins:light_level.png |}}

All that is required is to place a text box as shown above screenshot then place the number of your join into the serial join box, the number of the join will be the digital and analogue join of light that is to be controlled, in this example it is serial join 5001.

**Scenes**

Still to add to wiki

__**Congratulations you are ready to upload.**__


===== Items Not Working Properly =====

**B**

Before you add your cbus project into commandfusion there are some steps to follow and understand,
CommandFusion Wiki

User Tools

Site Tools

Page Tools
