Codecore Logo
Quick Search
»
Advanced Search »

Ocelot Driver

RSS
This driver supports the following ADI Ocelot (CPU-XA) features: sending X10 commands, sending IR from Ocelot and SECU16IR units, setting relays.

Manufacturer: Applied Digital, Inc.

Primary Communications Port: Serial


Configuration Settings

  • Serial Port Name : (optional) The name of the serial port that the Insteon PLM is connected to. Ex. COM1 This setting is unused if the com USB.
  • X10 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

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

UnitTypes

Gets the type for all units.

Accessibility : Read Only

Type: Array

UnitFirmwareVersions

Gets the firmware version for all units.

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

SendResidentIR ( Number )

Send an IR command from the Ocelot.

Syntax

void SendResidentIR( Number irNumber )

Parameters

irNumber : The ir number to send. (1-1023)

SendRemoteIR ( Number, Number, Number )

Send an IR command from a SECU16IR unit.

Syntax

void SendRemoteIR( Number sECU16IRUnitNumber, Number zoneNumber, Number irNumber )

Parameters

sECU16IRUnitNumber : The SECU16IR unit number. (1-128)
zoneNumber : The zone number. (0-15, or 255 for all)
irNumber : The ir number to send. (1-1023)

WriteRelayOutput ( Number, Number, Boolean )

Sets a relay on the specified unit.

Syntax

void WriteRelayOutput( Number unitNumber, Number relayNumber, Boolean state )

Parameters

unitNumber : The unit number.
relayNumber : The relay number. (0-7)
state : The relay state.

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

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

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)

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 ( 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.

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.

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.

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

TurnOffAllLights

Turns all lights off.

Syntax

void TurnOffAllLights( )

Parameters

none

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 ( 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.

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.