Codecore Logo
Quick Search
»
Advanced Search »

Clipsal C-Bus Driver

RSS
This driver supports control and monitoring of the Clipsal C-Bus Network. This driver is coded to interface with the Lighting Application, and to interface to the C-Bus network using the 5500PC module via RS232. This protocol is locked to 9600 Baud, and the driver we reset the interface at startup

Manufacturer: Clipsal

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : The name of the serial port that C-Bus is connected to. Ex. COM1
  • Light Names : (optional) Enter the name of each Light Zone output on the Matrix.

Events

Light Group Power State Changed

Occurs when the current power setting for the zone changes.

Whenever Filter:

  • PropertyIndex : (optional) The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Light Level Changed

Occurs when the current level setting for the light group changes.

Whenever Filter:

  • PropertyIndex : (optional) The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Instance Properties

LightNames

Gets the name of all zones.

Accessibility : Read Only

Type: Array

LightOnOffs

Gets or sets the current power setting for the Light Group. The setting is On/Off or True/False.

Accessibility : Read Only

Type: Array

LightLevels

Gets or sets the current level setting for the Light Group ID. The scale is 0 to 100.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

SendRawCommand ( String )

Send a raw command to the projector

Syntax

void SendRawCommand( String rawCommand )

Parameters

rawCommand : The command to send

SetLightPower ( Number, Boolean )

Change the Power Status for a Light Group.

Syntax

void SetLightPower( Number groupID, Boolean power )

Parameters

groupID : The zone number.
power : Set the Power Status to ON or OFF

TurnOffLight ( Number )

Turn Off the Power for a Light Group.

Syntax

void TurnOffLight( Number groupID )

Parameters

groupID : The light group number.

TurnOnLight ( Number )

Turn On the Power for a Light Group.

Syntax

void TurnOnLight( Number groupID )

Parameters

groupID : The light group number.

ToggleLightPower ( Number )

Toggle the Power for a Light Group.

Syntax

void ToggleLightPower( Number groupID )

Parameters

groupID : The light group number.

TurnOnLightByName ( String )

Turns on the specified node.

Syntax

void TurnOnLightByName( String name )

Parameters

name : The name of the light.

TurnOffLightByName ( String )

Turns off the specified node.

Syntax

void TurnOffLightByName( String name )

Parameters

name : The name of the light.

TurnOffAllLights

Power Down all Light Groups.

Syntax

void TurnOffAllLights( )

Parameters

none

TurnOnAllLights

Power Up all Light Groups.

Syntax

void TurnOnAllLights( )

Parameters

none

SetLightLevel ( Number, Number )

Change the Level for a Ligth Group.

Syntax

void SetLightLevel( Number groupID, Number level )

Parameters

groupID : The zone number.
level : Level (0=Dark, 100=Bright)

RampLightLevel ( Number, Number, String )

Change the Level for a Ligth Group of a period of time.

Syntax

void RampLightLevel( Number groupID, Number level, String ramp )

Parameters

groupID : The zone number.
level : Level (0=Dark, 100=Bright)
ramp : The duration elapsed to reach the requested Level

SetLightLevelByName ( String, Number )

Sets the specified node's level to the specified percent.

Syntax

void SetLightLevelByName( String name, Number percentOn )

Parameters

name : The name of the light.
percentOn : The percent level to set the light to. Valid values: 0 to 99 where 0 is typically off and 99 is fully on.

SetPropertyForDuration ( String, TimeSpan, IScriptObject, IScriptObject )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, IScriptObject, IScriptObject )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.