Lighting Simulator Driver

RSS

This driver simulates a real lighting system and is helpful for demonstrating the system and viewing/designing touch screen interfaces when a real lighting system is not available. If your Elve system came preconfigured with an instance of this driver in the device list, you will likely want to replace this with the appropriate device driver for your system.

Manufacturer: Codecore Technologies, LLC

Table of Contents [Hide/Show]

Configuration Settings
Events
   Light Level Changed
   Light On/Off State Changed
   Ready State Changed
Instance Properties
   Connected
   LightLevels
   LightOnOffs
   LightNames
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   SendRawCommand ( String )
   TurnOnLight ( Number )
   TurnOffLight ( Number )
   SetLightLevel ( Number, Number )
   TurnOnAllLights
   TurnOffAllLights
   TurnOnLightByName ( String )
   TurnOffLightByName ( String )
   SetLightLevelByName ( String, Number )
   SetLightLevelForDuration ( Number, TimeSpan, Number, Number )
   TurnOnLightForDuration ( Number, TimeSpan )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

Device List : (optional) Enter the name of each X10 device next to its ID.

Events

Light Level Changed

Occurs when a light's level changes.

Whenever Filter:

PropertyIndex : 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 On/Off State Changed

Occurs when the light changes from on to off or off to on. Any level greater than zero is considered on.

Whenever Filter:

PropertyIndex : 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

Connected

Gets a value indicating if a connection is established with the Nuvo.

Accessibility : Read Only

Type: Boolean

LightLevels

Gets the percent on level of the lights. 0-99

Accessibility : Read Only

Type: Array

LightOnOffs

Gets or sets the light to a fully on state or fully off.

Accessibility : Read Only

Type: Array

LightNames

Gets the names of the lights.

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 )

Sends a command that may otherwise not be supported by the driver. Most commands start with a'$>28001' prefix. You do not need to include the checksum or ending '#'.

Syntax

void SendRawCommand( String command )

Parameters

command : The command string to send. The driver will append the command with a carriage-return .

TurnOnLight ( Number )

Turns on the specified light.

Syntax

void TurnOnLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

TurnOffLight ( Number )

Turns off the specified light.

Syntax

void TurnOffLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

SetLightLevel ( Number, Number )

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

Syntax

void SetLightLevel( Number deviceID, Number percentOn )

Parameters

deviceID : The device id (1-256).

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

TurnOnAllLights

Turns all lights on.

Syntax

void TurnOnAllLights( )

Parameters

none

TurnOffAllLights

Turns all lights off.

Syntax

void TurnOffAllLights( )

Parameters

none

TurnOnLightByName ( String )

Turns on the specified light.

Syntax

void TurnOnLightByName( String name )

Parameters

name : The name of the light.

TurnOffLightByName ( String )

Turns off the specified light.

Syntax

void TurnOffLightByName( String name )

Parameters

name : The name of the light.

SetLightLevelByName ( String, Number )

Sets the specified light's % level to the specified percent.

Syntax

void SetLightLevelByName( String name, Number percentOn )

Parameters

name : The name of the light.

percentOn : The brightness percent level to set the device to. (0-99)

SetLightLevelForDuration ( Number, TimeSpan, Number, Number )

Sets a light's level for a duration of time and then sets the light to a subsequent level.

Syntax

void SetLightLevelForDuration( Number iD, unknown duration, Number initialPercentOn, Number finalPercentOn )

Parameters

iD : The id of the light.

duration : The amount of time to wait before setting the light level to the specified subsequent light level.

initialPercentOn : The percent level to set the light to.

finalPercentOn : The percent level to set the light to after the duration has passed.

TurnOnLightForDuration ( Number, TimeSpan )

Turns a light fully on for a duration of time and then turns the light off.

Syntax

void TurnOnLightForDuration( Number iD, unknown duration )

Parameters

iD : The id of the light.

duration : The amount of time to wait before turning off the light.

SetPropertyForDuration ( String, TimeSpan, Object, Object )

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, Object, Object )

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.