Clipsal C-Bus® Plus Interface

(c) 2009-2019 My Device.

www.mydevice.com.au

This driver provides control over the Clipsal C-Bus lighting system as well as 2-way feedback via variables and events.

Note:

Due to the sheer magnitude of the addressing system used in C-Bus we can't provide feedback for every Application. Full 2-way feedback is provided for the following Applications:

56 (0x38) - Lighting

57 (0x39) - Lighting

90 (0x5a) - Bacnet/Unassigned

95 (0x5f) - Unassigned

172 (0xac) - HVAC

202 (0xca) - Trigger Control

203 (0xcb) - Enable Control

208 (0xd0) - Security

You may use any other Application for the commands, but feedback will not be provided.

Please report any bugs found to bugs@mydevice.com.au. Include driver version number and steps to reproduce the issue where possible.

Driver Configuration Settings:

Connection:

Connection Type - Select the method to connect to the C-Bus system (TCP or Serial).

TCP Settings:

Only fill out this section if connecting via TCP to a CNI device.

TCP Address - IP address of the C-Bus CNI device. This should be a static address.

TCP Port - Port number to connect to on the C-Bus CNI device. Unless you have changed this in the CNI you should leave this as the default value of 10001.

Serial Settings:

Only fill out this section if connecting via a PCI device.

Serial Port - XP8 port that the PCI is connected to.

Baud Rate - Unless you have changed this in the PCI leave the default value of 9600 selected.

Global Settings:

Default Language - Select your preferred language. Available choices are:

English

English (Australia)

English (Belize)

English (Canada)

English (Carribean)

English (Ireland)

English (Jamaica)

English (New Zealand)

English (Philippines)

English (South Africa)

English (Trinidad)

English (UK)

English (USA)

English (Zimbabwe)

Afrikaans

Basque

Catalan

Danish

Dutch (Belgium)

Dutch (Netherlands)

Faeroese

Finnish

French (Belgium)

French (Canada)

French

French (Lixembourg)

French (Monaco)

French (Switzerland)

Galician

German (Austria)

German

German (Liechtenstein)

German (Luxembourg)

German (Switzerland)

Icelandic

Indonesian

Italian

Italian (Switzerland)

Malay (Brunei)

Malay

Norwegian

Norwegian (Nynorsk)

Portuguese (Brazil)

Portuguese

Spanish (Argentine)

Spanish (Bolivia)

Spanish (Chile)

Spanish (Colombia)

Spanish (Costa Rica)

Spanish (Dominican Republic)

Spanish (Ecuador)

Spanish (El Salvador)

Spanish (Guatemala)

Spanish (Honduras)

Spanish

Spanish (Mexico)

Spanish (Nicaragua)

Spanish (Panama)

Spanish (Paraguay)

Spanish (Peru)

Spanish (Perto Rico)

Spanish (Traditional)

Spanish (Uruguay)

Spanish (Venezuela)

Swahili

Swedish

Swedish (Finland)

Chinese

Functions:

Lighting:

Group On

This function turns a lighting application/group on.

Application : 56 (default lighting application).

Group : Group address to switch On.

Group Off

This function turns a lighting application/group off.

Application : 56 (default lighting application).

Group : Group address to switch Off.

Group Toggle

This function toggles a lighting application/group on/off.

Application : 56 (default lighting application).

Group : Group address to toggle.

Group Ramp

This function ramps a lighting application/group to a percentage.

Application : 56 (default lighting application).

Group : Group address to ramp.

Level Percentage : Level to ramp to (0 - 100).

Ramp Rate: Length of time taken to reach the specified level (Instantaneous, 4s, 8s, 12s, 20s, 30s, 40s, 1m, 1.5m, 2m, 3m, 5m, 7m, 10m, 15m or 17m).

Group Pulse

This function pulses a group for a length of time. ie. it turns the group on, waits, then off again.

Application : 56 (default lighting application).

Group : Group address to pulse.

Pulse Length: Pulse on time in milliseconds (1 - 65535).

Group Nudge Up

This function bumps a lighting application/group up.

Application : 56 (default lighting application).

Group : Group address to nudge.

Group Nudge Down

This function bumps a lighting application/group down.

Application : 56 (default lighting application).

Group : Group address to nudge.

Group Label

This function changes the text on a DLT switch.

Application : 56 (default lighting application).

Group : Group address to change.

Flavour : (0 - 3)

Label String: Text to display.

Enable Control:

Set Network Variable

This function stores a value to the network.

Application : 203 (default enable control application).

Variable : ID of the variable to set (0 - 255).

Value : Value to store (0 - 255).

Security:

Status 1 Request

This function requests for the security system to report its current status.

Application : 208 (default security application).

Status 2 Request

This function requests for the security system to report additional zone status.

Application : 208 (default security application).

Arm System

This function sends a request to arm the alarm system.

Application : 208 (default security application).

Arm Mode: Choose from:

Arm to Away Mode

Arm to Night (Home) Mode

Arm to Day Mode

Arm to Vacation Mode

Arm to Highest Level of Protection

Raise Tamper

This function sends a tamper alert to the alarm.

Application : 208 (default security application).

Drop Tamper

This function sends cancels a previously raised tamper.

Application : 208 (default security application).

Raise Alarm

This function signals an alarm state to the alarm panel.

Application : 208 (default security application).

Emulate Keypad

This function emulates the press of a key on the alarm panel's keypad.

Application : 208 (default security application).

Key : (0 - 255)

The following values have special meaning:

13 (0x0d) - Enter

128 (0x80) - Shift

129 (0x81) - Panic

130 (0x82) - Fire

131 (0x83) - Arm

132 (0x84) - Away

133 (0x85) - Night

134 (0x86) - Day

135 (0x87) - Vacation

Display Message

This function places a text message on to the security panel display.

Application : 208 (default security application).

Text : Message to display.

Request Zone Name

This function requests the text name for a given zone.

Application : 208 (default security application).

Text : Message to display.

Trigger Control:

Set Network Variable

This function stores a value to the network.

Application : 202 (default trigger control application).

Variable : ID of the variable to set (0 - 255).

Value : Value to store (0 - 255).

Variables:

Due to the large number of variables needed, they have been grouped per Application ID and then further broken into groups of 64.

Application 56: Lighting

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for a lighting group as an integer percentage (0 - 100).

Application 57: Lighting

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for a lighting group as an integer percentage (0 - 100).

Application 95: Unassigned

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for the unassigned group as an integer percentage (0 - 100). Use this application for any custom control work which requires feedback.

Application 172: HVAC

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for a HVAC control group as an integer percentage (0 - 100).

Application 202: Trigger Control

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for a trigger control group as an integer percentage (0 - 100).

Application 203: Enable Control

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for an enable control group as an integer percentage (0 - 100).

Application 208: Security

Group 0 - 255 (0x00 - 0xff)

Each variable provides feedback for a security group as an integer percentage (0 - 100).