Codecore Logo
Quick Search
»
Advanced Search »

ACT TI103 X10 Driver

RSS
The ACT TI103-RS232 (and TI203, TI213) is a power line carrier transceiver with a serial data communication port. It can be used to monitor and control X10, ACT, Leviton, and many other power line control modules. The recommended DIP switch settings for North American users should have all dip switches set to OFF except #7 should be ON. If you live in a country which uses 50Hz power then set #7 to OFF. To use the Set Light Level action you must first set the appropriate dimming type (none, standard dimming, preset dimming, extended direct dim) for each x10 module in the device's Device List setting.

Manufacturer: Advanced Control Technologies (ACT)

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : The name of the serial port that the hardware is connected to. Ex. COM1
  • Serial Port Speed : (optional) Baud rate for serial port, 9600 or 19200 (default value is 9600). Check the dip switch 8 in the TI103, OFF=9600, ON=19200. 9600 is more reliable and is the default DIP switch setting.
  • Device List : (optional) Enter the name and dimming type of each X10 device next to its ID. If a device does not support dimming then choose none. You may need to refer to the device manual or try different dimming types to determine which are supported. Extended Direct Dim is the best, then Preset Dim then Standard Dimming.

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 : Enter the device id which is the numeric form of the house/unit codes. You can get the ID by viewing the Device List configuration setting on the device and cross referencing the house code/unit code. For example A1 is 1, B1 is 17.

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.

Received X10 Command

Occurs when an X10 command code is received (except the preset dim command which has it's own event).

Whenever Filter:

  • DeviceCode : (optional) The device code (1-16).
  • CommandCode : (optional) The command code.
  • HouseCode : (optional) The X10 house code (A-P).

EventArgs:

  • Number DeviceCode : The device code (1-16).
  • String HouseCode : The X10 house code (A-P).
  • Number CommandCode : The command code.

Received X10 Preset Dim Command

Occurs when an X10 preset dim command code is received.

Whenever Filter:

  • HouseCode : (optional) The X10 house code (A-P).
  • DeviceCode : (optional) The device code (1-16).
  • Level : (optional) The preset dim level value. (1-32)

EventArgs:

  • Number Level : The preset dim level value. (1-32)
  • String HouseCode : The X10 house code (A-P).
  • Number DeviceCode : The device code (1-16).

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-100

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 .

SendX10Command ( String, Number, Number )

Sends a full X10 Command to the powerline.

Syntax

void SendX10Command( String houseCode, Number unitCode, Number commandCode )

Parameters

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

0 = All Units Off
1 = All Lights On
2 = On
3 = Off
4 = Dim
5 = Bright
6 = All Lights Off
7 = Extended Code
8 = Hail Request
9 = Hail Acknowledge
12 = Extended Data (analog)
13 = Status = On
14 = Status = Off
15 = Status Request

SendX10PresetDimCommand ( String, Number, Number )

Sends an X10 preset dim command to the powerline.

Syntax

void SendX10PresetDimCommand( String houseCode, Number unitCode, Number level )

Parameters

houseCode : The X10 house code of the device. (A-P)
unitCode : The X10 unit code (1-16).
level : The preset dim level (1-32).

TurnOnLight ( String, Number )

Turns on the specified light.

Syntax

void TurnOnLight( String houseCode, Number unitCode )

Parameters

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

TurnOnLight ( Number )

Turns on the specified light.

Syntax

void TurnOnLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

TurnOffLight ( String, Number )

Turns off the specified light.

Syntax

void TurnOffLight( String houseCode, Number unitCode )

Parameters

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

TurnOffLight ( Number )

Turns off the specified light.

Syntax

void TurnOffLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

SetLightLevel ( String, Number, Number )

Sets the % level of the specified light (or PLC device) by house code and unit code. You must have set the appropriate dimming type (none, standard dimming, preset dimming, extended direct dim) for each x10 module in the device's Device List setting to use this action.

Syntax

void SetLightLevel( String houseCode, Number unitCode, Number percentOn )

Parameters

houseCode : The house code of the device. (A-P)
unitCode : The unit code (1-16).
percentOn : The brightness percent level to set the device to. (0-100)

SetLightLevel ( Number, Number )

Sets the specified light's level to the specified percent. You must have set the appropriate dimming type (none, standard dimming, preset dimming, extended direct dim) for each x10 module in the device's Device List setting to use this action.

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 100 where 0 is typically off and 100 is fully on.

TurnOnAllLights

Turns all lights on.

Syntax

void TurnOnAllLights( )

Parameters

none

TurnOnAllLights ( String )

Turn on all lights for the specified house code.

Syntax

void TurnOnAllLights( String houseCode )

Parameters

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

TurnOffAllLights

Turns all lights off.

Syntax

void TurnOffAllLights( )

Parameters

none

TurnOffAllLights ( String )

Turn off all lights for the specified house code.

Syntax

void TurnOffAllLights( String houseCode )

Parameters

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

AllUnitsOff ( String )

Turns off all units in the specified house code.

Syntax

void AllUnitsOff( String houseCode )

Parameters

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

Brighten ( String, Number, Number )

Brightens an X10 device.

Syntax

void Brighten( String houseCode, Number unitCode, Number percent )

Parameters

houseCode : The X10 house code of the device. (A-P)
unitCode : The X10 unit code (1-16).
percent : The percent to brighten.

Brighten ( Number, Number )

Brighten an X10 device.

Syntax

void Brighten( Number deviceID, Number percent )

Parameters

deviceID : The device id (1-256).
percent : The percent to brighten.

Dim ( String, Number, Number )

Dims an X10 device.

Syntax

void Dim( String houseCode, Number unitCode, Number percent )

Parameters

houseCode : The X10 house code of the device. (A-P)
unitCode : The X10 unit code (1-16).
percent : The percent to brighten.

Dim ( Number, Number )

Dims an X10 device.

Syntax

void Dim( Number deviceID, Number percent )

Parameters

deviceID : The device id (1-256).
percent : The percent to dim.

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. You must have set the appropriate dimming type (none, standard dimming, preset dimming, extended direct dim) for each x10 module in the device's Device List setting to use this action.

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-100)

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.

SimulateReceivedData ( String )

Simulate data being received from the serial port. The data will be processed as if it were actually received as incoming data from the serial ports. This is useful for testing.

Syntax

void SimulateReceivedData( String data )

Parameters

data : The data to simulate being received.

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.