X10 W800RF32 RF Receiver Driver

This driver uses an W800RF32 X10 RF receiver device connected to a serial port on the computer to receive X10 commands.

Manufacturer: WGL & Associates

Primary Communications Port: Serial

Table of Contents [Hide/Show] Configuration Settings Events    Ready State Changed    Received X10 RF Command    Received RF Security Code Instance Properties    DeviceDisplayName    DeviceStartTime    DeviceLifecycleStage    DeviceIsRunningAndReady Instance Methods    SetPropertyForDuration ( String, TimeSpan, Object, Object )    SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Configuration Settings

• Serial Port Name : The name of the serial port that the W800RF32 is connected to. Ex. COM1
• Repeated Command Tolerance : The number of milliseconds required to pass before a repeated incoming command is recognized as a new command. (default is 500 milliseconds)
  

Events

Ready State Changed

The device's running and ready state changed.

Whenever Filter:


EventArgs:

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

Received X10 RF Command

Occurs when a command is received.

Whenever Filter:

• HouseCode : (optional) The X10 house code (A-P).
• DeviceCode : (optional) The device code (1-16).
• CommandCode : (optional) The command code. 0=On, 1=Bright, 2=Off, 3=Dim
  

EventArgs:

• Number DeviceCode : The device code (1-16).
• Number CommandCode : The command code. 0=On, 1=Bright, 2=Off, 3=Dim
• String HouseCode : The X10 house code (A-P).
  

Received RF Security Code

Occurs when a command is received.

Whenever Filter:

• CommandType : (optional) The command type.
• DeviceCode : (optional) The device code (0-255).
• RawCommandCode : (optional) The actual received command code (0-255).
  

EventArgs:

• Number CommandType : The command type. 0=Unknown, 1=Sensor Alert, 2=Sensor Normal, 3=Arm Home, 4=Arm Away, 5=Disarm, 6=Panic, 7=Light On, 8=Light Off, 9=Temperature Below Setpoint, 10=Temperature Above Setpoint, 11=Darkness Detected, 12=Light Detected.
• Number DeviceCode : The device code (1-16).
• Number RawCommandCode : The actual received command code (0-255).
  

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

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


Parameters

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


Parameters