Codecore Logo
Quick Search
»
Advanced Search »

CM17A Firecracker Driver

RSS
Image
This driver uses an X10 CM17A (Firecracker) RF transmitter device connected to a serial port on the computer to control X10 devices.

Manufacturer: X10

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : The name of the serial port that the CM17A is connected to. Ex. COM1

Events

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

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

TurnOn ( String, Number )

Turns on an X10 device.

Syntax

void TurnOn( String houseCode, Number deviceCode )

Parameters

houseCode : The X10 house code of the device. (A-P)
deviceCode : The X10 unit code (1-16).

TurnOff ( String, Number )

Turns off an X10 device.

Syntax

void TurnOff( String houseCode, Number deviceCode )

Parameters

houseCode : The X10 house code of the device. (A-P)
deviceCode : The X10 unit code (1-16).

Brighten ( String )

Brightens the most recently referenced X10 device in the specified house code.

Syntax

void Brighten( String houseCode )

Parameters

houseCode : The X10 house code of the device. (A-P)

Dim ( String )

Dims the most recently referenced X10 device in the specified house code.

Syntax

void Dim( String houseCode )

Parameters

houseCode : The X10 house code of the device. (A-P)

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 )

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.