Codecore Logo
Quick Search
»
Advanced Search »

Elk M1 Driver

RSS
Image
This driver connects to an Elk Products Elk M1 security and automation panel via the computer's network or through a serial port.

Manufacturer: Elk Products

Primary Communications Port: Serial, Network

Table of Contents [Hide/Show]


Configuration Settings
Events
   Thermostat Current Temperature Changed
   Thermostat Cool Set Point Changed
   Thermostat Current Humidity Changed
   Thermostat Fan Mode Changed
   Thermostat Heat Set Point Changed
   Thermostat Hold State Changed
   Thermostat Mode Changed
   Probe Temperature Changed
   Keypad Temperatures Changed
   Zone Logical Status Changed
   Zone Physical Status Changed
   Area Arm Status Changed
   Area Arm Up Status Changed
   Area Alarm State Changed
   Light Level Changed
   Light On/Off State Changed
   Output State Changed
   Area Chime Mode Changed
   Custom Value Changed
   Counter Value Changed
   Custom Value Format Changed
   Ready State Changed
   Zone Status Change
   Area Status Change
   Output State Change
   Function Key Press
   Key Pressed
   Light Level Changed
Instance Properties
   Connected
   ThermostatCurrentTemperatures
   ThermostatCoolSetPoints
   ThermostatCurrentHumidities
   ThermostatFanModes
   ThermostatFanModeTexts
   ThermostatHeatSetPoints
   ThermostatHolds
   ThermostatModes
   ThermostatModeTexts
   ProbeTemperatures
   KeypadTemperatures
   ZoneLogicalStatuses
   ZoneLogicalStatusTexts
   ZonePhysicalStatuses
   ZonePhysicalStatusTexts
   AreaArmStatuses
   AreaArmStatusTexts
   AreaArmUpStates
   AreaArmUpStateTexts
   AreaAlarmStates
   AreaAlarmStateTexts
   LightLevels
   LightOnOffs
   LightNames
   OutputStates
   OutputNames
   TaskNames
   ZoneNames
   ThermostatNames
   AreaNames
   CustomValueNames
   CounterNames
   AreaChimeModes
   CustomValues
   CounterValues
   CustomValuesFormatted
   CustomValueFormats
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   ClearKeypadText ( Number, Boolean )
   SetKeypadText ( Number, Boolean, String, String )
   SetKeypadTextForDuration ( Number, Boolean, TimeSpan, String, String )
   TurnOnOutput ( Number )
   TurnOnOutputForDuration ( Number, TimeSpan )
   TurnOffOutput ( Number )
   ToggleOutput ( Number )
   ActivateTask ( Number )
   SpeakWord ( Number )
   SpeakPhrase ( Number )
   TriggerZone ( Number )
   SendRawCommand ( String, String )
   Disarm ( Number, Number )
   ArmAway ( Number, Number )
   ArmStay ( Number, Number )
   ArmStayInstant ( Number, Number )
   ArmNight ( Number, Number )
   ArmNightInstant ( Number, Number )
   ArmVacation ( Number, Number )
   CycleAwayMode ( Number, Number )
   CycleStayMode ( Number, Number )
   TurnOnLight ( String, Number )
   TurnOnLight ( Number )
   TurnOffLight ( String, Number )
   TurnOffLight ( Number )
   TurnOnAllLights
   TurnOnAllLights ( String )
   TurnOffAllLights
   TurnOffAllLights ( String )
   ToggleLight ( Number )
   ToggleLight ( String, Number )
   SetLightLevel ( Number, Number )
   SetLightLevel ( String, Number, Number )
   TurnOnLightByName ( String )
   TurnOffLightByName ( String )
   SetLightLevelByName ( String, Number )
   SetLightLevelForDuration ( Number, TimeSpan, Number, Number )
   TurnOnLightForDuration ( Number, TimeSpan )
   SetThermostatCoolSetPoint ( Number, Number )
   SetThermostatHeatSetPoint ( Number, Number )
   SetThermostatHold ( Number, Boolean )
   SetThermostatMode ( Number, Number )
   SetThermostatFanMode ( Number, Number )
   PressFunctionKey ( Number, String )
   SetCustomValue ( Number, Number )
   SetCounterValue ( Number, Number )
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )


Configuration Settings

  • Host Name : (optional) The host name or ip address of the Elk M1 network interface.
  • Port : (optional) The un-secure Elk M1 port. Defaults to 2101.
  • SerialPortName : (optional) The name of the serial port that the ELK M1 is connected to. Ex. COM1

Events

Thermostat Current Temperature Changed

Occurs when a thermostat current temperature 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.

Thermostat Cool Set Point Changed

Occurs when a thermostat cool set point 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.

Thermostat Current Humidity Changed

Occurs when a thermostat current humidity 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.

Thermostat Fan Mode Changed

Occurs when a thermostat fan mode 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.

Thermostat Heat Set Point Changed

Occurs when a thermostat heat set point 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.

Thermostat Hold State Changed

Occurs when a thermostat hold state 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.

Thermostat Mode Changed

Occurs when a thermostat mode 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.

Probe Temperature Changed

Occurs when a probe's temperature 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.

Keypad Temperatures Changed

Occurs when a keypad's temperature 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.

Zone Logical Status Changed

Occurs when a zone's logical status 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.

Zone Physical Status Changed

Occurs when a zone's physical status 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.

Area Arm Status Changed

Occurs when an area's arm status changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the area (1-8) to watch for arm status changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Area Arm Up Status Changed

Occurs when an area's arm up state changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the area (1-8) to watch for arm up state changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Area Alarm State Changed

Occurs when an area's alarm state changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the area (1-8) to watch for alarm state changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Light Level Changed

Occurs when a light's (or plc device's) level changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the light (1-256) to watch for level changes.

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.

Output State Changed

Occurs when an output's state changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the output (1-208) to watch for state changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Area Chime Mode Changed

Occurs when an area's chime mode changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the area (1-8) to watch for chime mode changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Custom Value Changed

Occurs when a custom value changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the custom value (1-20) to watch for changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Counter Value Changed

Occurs when a custom value changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the counter value (1-64) to watch for changes.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Custom Value Format Changed

Occurs when a custom value's forma changes.

Whenever Filter:

  • PropertyIndex : Set this to the ID of the custom value (1-20) to watch for format changes.

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.

Zone Status Change

Occurs when a zone's physical status changes, such as when a zone changes from Normal to Violated.

Whenever Filter:

  • Status : (optional) The event will be triggered if the zone's physical status matches.
  • ZoneID : Specifies the zone id that this rule applies to (1-208).

EventArgs:

  • Number NewStatusNumber : The new zone status.
  • String NewStatusText : The new zone status text.
  • Number ZoneID : The ID of the zone that changed status.
  • Number PrevStatusNumber : The previous zone status.

Area Status Change

Occurs when an area's arm status, arm up state, and/or alarm state changes.

Whenever Filter:

  • AreaID : Specifies the area id that this rule applies to (1-8).
  • ArmStatus : (optional) The event will be triggered if the area's new arm status matches.
  • ArmUpState : (optional) The event will be triggered if the area's new arm up state matches.
  • AlarmState : (optional) The event will be triggered if the area's new alarm state matches.

EventArgs:

  • Number CurrentArmUpStateNumber : The previous area arm up state.
  • Number PrevArmStatusNumber : The ID of the area that changed arm status.
  • Number CurrentArmStatusNumber : The previous area arm status.
  • Number CurrentArmStatusText : The current area arm status.
  • String PrevArmUpStateNumber : The current area arm status text.
  • String CurrentAlarmStateText : The current area alarm state text.
  • String CurrentArmUpStateText : The current area arm up state text.
  • Number PrevAlarmStateNumber : The previous area alarm state.
  • Number CurrentAlarmStateNumber : The current area alarm state.

Output State Change

Occurs when an output changes state.

Whenever Filter:

  • OutputID : Specifies the output id that this rule applies to (1-208).
  • State : (optional) The event will be triggered if the new output state matches.

EventArgs:

  • Boolean NewState : The new output state.
  • Number OutputID : The ID of the output that changed state (1-208).
  • Boolean PrevState : The previous output state.

Function Key Press

Occurs when a function key, star or chime button is pressed on a keypad.

Whenever Filter:

none

EventArgs:

  • Number KeypadID : The ID of the keypad where the function key was pressed (1-16).
  • String KeyID : The ID of the key that was pressed. '1' to '6' for F keys, '*' = Star button, 'C' = Chime button.
  • Array ChimeModes : An array of numeric chime modes for each area 1 to 8, 0=Off, 1=Chime only, 2=Voice only, 3=Chime and voice.

Key Pressed

Occurs when a keypad key changes state.

Whenever Filter:

  • KeypadID : (optional) Specifies the keypad id that this rule applies to (1-16).
  • KeyCode : The key code.

EventArgs:

  • String KeyName : The text name of the key.
  • Array IlluminationStatus : The function key illumination statuses. 0 = Off, 1 = On constant, 2 = On Blinking.
  • Number KeypadID : The ID of the keypad. 1-16.
  • Number KeyCode : The the key code.

Light Level Changed

Occurs when the level of a light (plc device) changes, for example when a light turns off.

Whenever Filter:

  • HouseCode : (optional) The house code of the device. (A-P)
  • DeviceID : (optional) The device id (1-256).
  • UnitCode : (optional) The unit code (1-16).
  • PercentOn : (optional) The new percent on level (0-99).

EventArgs:

  • String HouseCode : The house code of the device that changed (A-P).
  • Number UnitCode : The the unit code device that changed (1-16).
  • Number NewState : The previous percent on level (0-99).
  • Number NewPercentOn : The new percent on level (0-99).
  • Number DeviceID : The ID of the device that changed (1-256).

Instance Properties

Connected

Gets a value indicating if a connection is established with the Elk M1.

Accessibility : Read Only

Type: Boolean

ThermostatCurrentTemperatures

Gets the current thermostat temperatures.

Accessibility : Read Only

Type: Array

ThermostatCoolSetPoints

Gets the current thermostat cool set point temperatures.

Accessibility : Read Only

Type: Array

ThermostatCurrentHumidities

Gets the current thermostat humidities.

Accessibility : Read Only

Type: Array

ThermostatFanModes

Gets the current thermostat fan modes.

Accessibility : Read Only

Type: Array

ThermostatFanModeTexts

Gets the current thermostat fan modes as displayable text.

Accessibility : Read Only

Type: Array

ThermostatHeatSetPoints

Gets the current thermostat heat set point temperatures.

Accessibility : Read Only

Type: Array

ThermostatHolds

Gets the current thermostat hold states.

Accessibility : Read Only

Type: Array

ThermostatModes

Gets the current thermostat modes.

Accessibility : Read Only

Type: Array

ThermostatModeTexts

Gets the current thermostat modes as displayable text.

Accessibility : Read Only

Type: Array

ProbeTemperatures

Gets the current probe temperatures.

Accessibility : Read Only

Type: Array

KeypadTemperatures

Gets the current keypad temperatures.

Accessibility : Read Only

Type: Array

ZoneLogicalStatuses

Gets the logical status for all zones. -1=Unknown, 0=Unconfigured, 1=Open, 2=EOL, 3=Short

Accessibility : Read Only

Type: Array

ZoneLogicalStatusTexts

Gets the logical status as displayable text for all zones.

Accessibility : Read Only

Type: Array

ZonePhysicalStatuses

Gets the physical status for all zones. -1=Unknown, 0=Normal, 1=Trouble, 2=Violated, 3=Bypassed

Accessibility : Read Only

Type: Array

ZonePhysicalStatusTexts

Gets the physical status as displayable text for all zones.

Accessibility : Read Only

Type: Array

AreaArmStatuses

Gets the arm status for all areas. -1=Unknown, 0=Disarmed, 1=Armed Away, 2=Armed Stay, 3= Armed Stay Instant, 4= Armed Night, 5=Armed Night Instant, 6=Armed Vacation

Accessibility : Read Only

Type: Array

AreaArmStatusTexts

Gets the arm status as displayable text for all areas. -1=Unknown, 0=Disarmed, 1=Armed Away, 2=Armed Stay, 3= Armed Stay Instant, 4= Armed Night, 5=Armed Night Instant, 6=Armed Vacation

Accessibility : Read Only

Type: Array

AreaArmUpStates

Gets the arm up state for all areas. -1=Unknown, 0=Not Ready To Arm, 1=Ready To Arm, 2=Ready To Force Arm, 3=Armed With Exit Timer Working, 4=Armed Fully, 5=Force Armed With A Force Arm Zone Violated, 6=Armed With A Bypass

Accessibility : Read Only

Type: Array

AreaArmUpStateTexts

Gets the arm up state as displayable text for all areas.

Accessibility : Read Only

Type: Array

AreaAlarmStates

Gets the alarm state for all areas. Unknown = -1, No Alarm Active = 0, Entrance Delay Active = 1, Alarm Abort Delay Active = 2, Fire Alarm = 3, Medical Alarm = '4', Police Alarm = '5', Burglar Alarm = '6', Aux1 Alarm = '7', Aux2 Alarm = '8', Aux3 Alarm = '9', Aux4 Alarm = 10, Carbon Monoxide Alarm = 11, Emergency Alarm = 12, Freeze Alarm = 13, Gas Alarm = 14, Heat Alarm = 15, Water Alarm = 16, Fire Supervisory = 17, Verify Fire = 18

Accessibility : Read Only

Type: Array

AreaAlarmStateTexts

Gets the alarm state as displayable text for all areas. Unknown = -1, No Alarm Active = 0, Entrance Delay Active = 1, Alarm Abort Delay Active = 2, Fire Alarm = 3, Medical Alarm = '4', Police Alarm = '5', Burglar Alarm = '6', Aux1 Alarm = '7', Aux2 Alarm = '8', Aux3 Alarm = '9', Aux4 Alarm = 10, Carbon Monoxide Alarm = 11, Emergency Alarm = 12, Freeze Alarm = 13, Gas Alarm = 14, Heat Alarm = 15, Water Alarm = 16, Fire Supervisory = 17, Verify Fire = 18

Accessibility : Read Only

Type: Array

LightLevels

Gets or sets the levels for all lights (or plc devices).

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 for all lights.

Accessibility : Read Only

Type: Array

OutputStates

Gets the state of all outputs. true=closed, false=open

Accessibility : Read Only

Type: Array

OutputNames

Gets the names for all outputs.

Accessibility : Read Only

Type: Array

TaskNames

Gets the names for all tasks.

Accessibility : Read Only

Type: Array

ZoneNames

Gets the names for all zones.

Accessibility : Read Only

Type: Array

ThermostatNames

Gets the names for all thermostats.

Accessibility : Read Only

Type: Array

AreaNames

Gets the names for all areas.

Accessibility : Read Only

Type: Array

CustomValueNames

Gets the names for all custom values.

Accessibility : Read Only

Type: Array

CounterNames

Gets the names for all counters.

Accessibility : Read Only

Type: Array

AreaChimeModes

Gets the chime modes for all areas. -1=Unknown, 0=Off, 1=Chime Only, 2=Voice Only, 3=Chime and Voice

Accessibility : Read Only

Type: Array

CustomValues

Gets the custom values.

Accessibility : Read Only

Type: Array

CounterValues

Gets the counter values.

Accessibility : Read Only

Type: Array

CustomValuesFormatted

Gets the custom values as formatted text..

Accessibility : Read Only

Type: Array

CustomValueFormats

Gets the format for all custom values. 0=Number, 1=Timer, 2=Time Of Day

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

ClearKeypadText ( Number, Boolean )

Clears the text on all keypads in the the specified area.

Syntax

void ClearKeypadText( Number areaID, Boolean beep )

Parameters

areaID : The area (1-8) to set the keypad text.
beep : Indicates if the keypad(s) should beep.

SetKeypadText ( Number, Boolean, String, String )

Displays text on all keypads in the the specified area.

Syntax

void SetKeypadText( Number areaID, Boolean beep, String line1, String line2 )

Parameters

areaID : The area (1-8) to set the keypad text.
beep : Indicates if the keypad(s) should beep.
line1 : Up to 16 characters to show on line 1.
line2 : Up to 16 characters to show on line 2.

SetKeypadTextForDuration ( Number, Boolean, TimeSpan, String, String )

Displays text on all keypads in the the specified area for a duration of time.

Syntax

void SetKeypadTextForDuration( Number areaID, Boolean beep, unknown duration, String line1, String line2 )

Parameters

areaID : The area (1-8) to set the keypad text.
beep : Indicates if the keypad(s) should beep.
duration : The amount of time to display the message (Maximum of 18.2 hours).
line1 : Up to 16 characters to show on line 1.
line2 : Up to 16 characters to show on line 2.

TurnOnOutput ( Number )

Turns off an output.

Syntax

void TurnOnOutput( Number outputID )

Parameters

outputID : The ID of the output to turn on.

TurnOnOutputForDuration ( Number, TimeSpan )

Turns on an output for the specified number of seconds.

Syntax

void TurnOnOutputForDuration( Number outputID, unknown duration )

Parameters

outputID : The ID of the output to turn on.
duration : The amount of time to keep the output on (Maximum of 18.2 hours).

TurnOffOutput ( Number )

Opens an output

Syntax

void TurnOffOutput( Number outputID )

Parameters

outputID : The ID of the output to turn off.

ToggleOutput ( Number )

Toggles the on/off state of an output.

Syntax

void ToggleOutput( Number outputID )

Parameters

outputID : The ID of the output to toggle.

ActivateTask ( Number )

Activates the specified task.

Syntax

void ActivateTask( Number taskID )

Parameters

taskID : The ID of the task to activate.

SpeakWord ( Number )

Speaks the word associated with the specified ID.

Syntax

void SpeakWord( Number wordID )

Parameters

wordID : The ID of the desired word.

SpeakPhrase ( Number )

Speaks the phrase associated with the specified ID.

Syntax

void SpeakPhrase( Number phraseID )

Parameters

phraseID : The ID of the desired phrase.

TriggerZone ( Number )

Momentarily open and violate a zone.

Syntax

void TriggerZone( Number zoneID )

Parameters

zoneID : The zone (1-208) to momentarily open and violate.

SendRawCommand ( String, String )

Sends a command that may otherwise not be supported by the driver.

Syntax

void SendRawCommand( String command, String commandData )

Parameters

command : The two character command code.
commandData : The command data associated with the command code. This should be the raw data and should NOT include a checksum.

Disarm ( Number, Number )

Puts the alarm system in the disarmed state.

Syntax

void Disarm( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

ArmAway ( Number, Number )

Puts the alarm system in the armed away state.

Syntax

void ArmAway( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

ArmStay ( Number, Number )

Puts the alarm system in the armed stay state.

Syntax

void ArmStay( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

ArmStayInstant ( Number, Number )

Puts the alarm system in the armed stay instant state.

Syntax

void ArmStayInstant( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

ArmNight ( Number, Number )

Puts the alarm system in the armed night state.

Syntax

void ArmNight( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

ArmNightInstant ( Number, Number )

Puts the alarm system in the armed night instant state.

Syntax

void ArmNightInstant( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

ArmVacation ( Number, Number )

Puts the alarm system in the arm vacation state.

Syntax

void ArmVacation( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

CycleAwayMode ( Number, Number )

Cycles the alarm system's current arm state to the next away state.

Syntax

void CycleAwayMode( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

CycleStayMode ( Number, Number )

Cycles the alarm system's current arm state to the next stay state.

Syntax

void CycleStayMode( Number areaID, Number userCode )

Parameters

areaID : The area (1-8) to arm.
userCode : Four or six digit user code.

TurnOnLight ( String, Number )

Turns on the specified light (or PLC device).

Syntax

void TurnOnLight( String houseCode, Number unitCode_base1 )

Parameters

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

TurnOnLight ( Number )

Turns on the specified light (or PLC device).

Syntax

void TurnOnLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

TurnOffLight ( String, Number )

Turns off the specified light (or PLC device).

Syntax

void TurnOffLight( String houseCode, Number unitCode_base1 )

Parameters

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

TurnOffLight ( Number )

Turns off the specified light (or PLC device).

Syntax

void TurnOffLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

TurnOnAllLights

Turn on all lights.

Syntax

void TurnOnAllLights( )

Parameters

none

TurnOnAllLights ( String )



Syntax

void TurnOnAllLights( String houseCode )

Parameters

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

TurnOffAllLights

Turn off all lights.

Syntax

void TurnOffAllLights( )

Parameters

none

TurnOffAllLights ( String )



Syntax

void TurnOffAllLights( String houseCode )

Parameters

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

ToggleLight ( Number )

Toggles the on/off state the specified light (or PLC device) by house code and unit code.

Syntax

void ToggleLight( Number deviceID )

Parameters

deviceID : The device id (1-256).

ToggleLight ( String, Number )

Toggles the on/off state the specified light (or PLC device) by house code and unit code.

Syntax

void ToggleLight( String houseCode, Number unitCode_base1 )

Parameters

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

SetLightLevel ( Number, Number )

Sets the % level of the specified light (or PLC device) by device id.

Syntax

void SetLightLevel( Number deviceID, Number percentOn )

Parameters

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

SetLightLevel ( String, Number, Number )

Sets the % level of the specified light (or PLC device) by house code and unit code.

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

TurnOnLightByName ( String )

Turns on the specified light (or PLC device).

Syntax

void TurnOnLightByName( String name )

Parameters

name : The name of the light.

TurnOffLightByName ( String )

Turns off the specified light (or PLC device).

Syntax

void TurnOffLightByName( String name )

Parameters

name : The name of the light.

SetLightLevelByName ( String, Number )

Sets the % level of the specified light (or PLC device) by device name.

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.

SetThermostatCoolSetPoint ( Number, Number )

Sets the cool set point temperature of a thermostat.

Syntax

void SetThermostatCoolSetPoint( Number thermostatID, Number setPoint )

Parameters

thermostatID : The ID of the thermostat. (1-16)
setPoint : The cool set point temperature. (0-99)

SetThermostatHeatSetPoint ( Number, Number )

Sets the heat set point temperature of a thermostat.

Syntax

void SetThermostatHeatSetPoint( Number thermostatID, Number setPoint )

Parameters

thermostatID : The ID of the thermostat. (1-16)
setPoint : The heat set point temperature. (0-99)

SetThermostatHold ( Number, Boolean )

Sets the hold state of a thermostat.

Syntax

void SetThermostatHold( Number thermostatID, Boolean hold )

Parameters

thermostatID : The ID of the thermostat. (1-16)
hold : The hold state. true=hold is on, false=hold is off.

SetThermostatMode ( Number, Number )

Sets the cooling/heating mode of a thermostat.

Syntax

void SetThermostatMode( Number thermostatID, Number mode )

Parameters

thermostatID : The ID of the thermostat. (1-16)
mode : The mode. 0=Off, 1=Heat, 2=Cool, 3=Auto, 4=Emergency Heat

0 = Off
1 = Heat
2 = Cool
3 = Auto
4 = Emergency Heat

SetThermostatFanMode ( Number, Number )

Sets a thermostat's fan mode.

Syntax

void SetThermostatFanMode( Number thermostatID, Number fanMode )

Parameters

thermostatID : The ID of the thermostat.
fanMode : The fan mode: 0=auto, 1=on.

0 = Auto
1 = On

PressFunctionKey ( Number, String )

Presses a keypad key.

Syntax

void PressFunctionKey( Number keypadID, String key )

Parameters

keypadID : The keypad ID. (1-16)
key : Which function key pressed, 1-6, or '*' to silence trouble beep on keypads, 'C' to control Chime.

SetCustomValue ( Number, Number )

Sets the specified custom value.

Syntax

void SetCustomValue( Number customValueID, Number value )

Parameters

customValueID : The custom value ID. (1-20)
value : The value of the custom value. For time of day values use a decimal format, such as 13.5 for 1:30 pm.

SetCounterValue ( Number, Number )

Sets the specified counter value.

Syntax

void SetCounterValue( Number counterID, Number value )

Parameters

counterID : The counter value ID. (1-64)
value : The value of the counter value. (0-65535)

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.