Codecore Logo
Quick Search
»
Advanced Search »

Security Simulator Driver

RSS
This driver simulates a real security system and is helpful for demonstrating the system and viewing/designing touch screen interfaces when a real security system is not available. If your Elve system came preconfigured with an instance of this driver in the device list, you will likely want to replace this with the appropriate device driver for your system.

Manufacturer: Codecore Technologies, LLC


Configuration Settings

Events

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.

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 PrevStatusNumber : The previous zone status.
  • Number ZoneID : The ID of the zone that changed status.
  • Number NewStatusNumber : The new zone status.
  • String NewStatusText : The new zone status text.

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).
  • 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.
  • ArmStatus : (optional) The event will be triggered if the area's new arm status matches.

EventArgs:

  • Number PrevAlarmStateNumber : The previous area alarm 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.
  • Number CurrentArmUpStateNumber : The previous area arm up state.
  • String CurrentArmUpStateText : The current area arm up state text.
  • Number CurrentAlarmStateNumber : The current area alarm state.
  • String CurrentAlarmStateText : The current area alarm state text.

Instance Properties

Connected

Gets a value indicating if a connection is established with the security system.

Accessibility : Read Only

Type: Boolean

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

ZoneNames

Gets the names or all zones.

Accessibility : Read Only

Type: Array

AreaNames

Gets the names or all areas.

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

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.