DSC PowerSeries Driver

RSS

This driver supports the DSC IT-100 module.

Manufacturer:

Primary Communications Port: Serial

Table of Contents [Hide/Show]

Configuration Settings
Events
   DSC Version Changed
   DSCInfo
   DSCKeypadDisplayLine1
   DSCKeypadDisplayLine0
   DSCAuxiliaryInputAlarm
   DSCLEDStates
   DSCPartitionArmedDescriptiveMode
   DSCTrouble
   DSCExitDelayInProgress
   DSCEntryDelayInProgress
   DSCPartitionReady
   DSCPartitionArmed
   DSCPartitionAlarm
   DSCPartitionPartialClosing
   DSCPartitionSpecialClosing
   DSCZoneAlarmStates
   DSCZoneTamperStates
   DSCZoneFaultStates
   DSCZoneOpenStates
   Ready State Changed
Instance Properties
   ZoneNames
   DSCVersion
   DSCInfo
   DSCKeypadDisplayLine1
   DSCKeypadDisplayLine0
   DSCAuxiliaryInputAlarm
   DSCLEDStates
   DSCPartitionArmedDescriptiveMode
   DSCTrouble
   DSCExitDelayInProgress
   DSCEntryDelayInProgress
   DSCPartitionReady
   DSCPartitionArmed
   DSCPartitionAlarm
   DSCPartitionPartialClosing
   DSCPartitionSpecialClosing
   DSCZoneAlarmStates
   DSCZoneTamperStates
   DSCZoneFaultStates
   DSCZoneOpenStates
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   SendRawCommand ( String )
   StatusRequest
   LabelRequest
   DisableTimeStamp
   DSCArmWithCode ( Number, Number )
   DSCArmAway ( Number )
   DSCArmStay ( Number )
   DSCArmNoEntryDelay ( Number )
   DSCSendCode ( Number )
   DSCKeyPressed ( String )
   DSCLongKeyPressed ( String )
   SetPropertyForDuration ( String, TimeSpan, IScriptObject, IScriptObject )
   SetPropertyForDuration ( String, Number, TimeSpan, IScriptObject, IScriptObject )

Configuration Settings

Serial Port Name : Serial port that the driver is connected to. Ex. COM1
Six Digit Code : (optional) 6-digit code. Default is false.

Events

DSC Version Changed

Occurs when the security's software version changes.

Whenever Filter:

none

EventArgs:

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

DSCInfo

Occurs when the security's info changes.

Whenever Filter:

none

EventArgs:

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

DSCKeypadDisplayLine1

Occurs when the security's keypad display line 1 changes.

Whenever Filter:

none

EventArgs:

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

DSCKeypadDisplayLine0

Occurs when the security's keypad display line 0 changes.

Whenever Filter:

none

EventArgs:

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

DSCAuxiliaryInputAlarm

Occurs when the security's auxiliary alarm input state changes.

Whenever Filter:

none

EventArgs:

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

DSCLEDStates

Occurs when a LED state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCPartitionArmedDescriptiveMode

Occurs when a partition armed descriptive mode changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCTrouble

Occurs when a partition exit delay in progress state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCExitDelayInProgress

Occurs when a partition exit delay in progress state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCEntryDelayInProgress

Occurs when a partition entry delay in progress state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCPartitionReady

Occurs when a partition state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCPartitionArmed

Occurs when a partition armed state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCPartitionAlarm

Occurs when a partition alarm state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCPartitionPartialClosing

Occurs when a partition partial closing state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCPartitionSpecialClosing

Occurs when a partition special closing state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCZoneAlarmStates

Occurs when a zone alarm state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCZoneTamperStates

Occurs when a zone tamper state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCZoneFaultStates

Occurs when a zone fault state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

DSCZoneOpenStates

Occurs when a zone fault state changes.

Whenever Filter:

PropertyIndex : (optional) 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.

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

ZoneNames

Gets zone names

Accessibility : Read Only

Type: Array

DSCVersion

Gets the software version.

Accessibility : Read Only

Type: String

DSCInfo

Gets the info.

Accessibility : Read Only

Type: String

DSCKeypadDisplayLine1

Gets the keypad display line 1.

Accessibility : Read Only

Type: String

DSCKeypadDisplayLine0

Gets the keypad display line 0.

Accessibility : Read Only

Type: String

DSCAuxiliaryInputAlarm

Gets the auxiliary alarm input state.

Accessibility : Read Only

Type: Boolean

DSCLEDStates

Gets LED states. 1 = Ready, 2 = Armed, 3 = Memory, 4 = Bypass, 5 = Trouble, 6 = Program, 7 = Fire, 8 = Backlight, 9 = AC. State: 0 = Off, 1 = On, 2 = Flashing.

Accessibility : Read Only

Type: Array

DSCPartitionArmedDescriptiveMode

Gets partition armed descriptive mode. 0 = Away, 1 = Stay, 2 = Away, No Delay, 3 = Stay, No Delay.

Accessibility : Read Only

Type: Array

DSCTrouble

Gets partition trouble state. 0 = Panel Battery, 1 = Panel AC, 2 = System Bell, 3 = TLM Line1, 4 = TLM Line2, 5 = FTC, 6 = Buffer Near Full, 7 = General Device Low Battery, 8 = Wireless Key Low Battery, 9 = Handheld Keypad Low Battery, 10 = General System Tamper, 11 = Home Automation, 12 = Trouble Status, 13 = Fire Trouble Alarm.

Accessibility : Read Only

Type: Array

DSCExitDelayInProgress

Gets partition exit delay in progress state.

Accessibility : Read Only

Type: Array

DSCEntryDelayInProgress

Gets partition entry delay in progress state.

Accessibility : Read Only

Type: Array

DSCPartitionReady

Gets partition ready states.

Accessibility : Read Only

Type: Array

DSCPartitionArmed

Gets partition armed states.

Accessibility : Read Only

Type: Array

DSCPartitionAlarm

Gets partition alarm states.

Accessibility : Read Only

Type: Array

DSCPartitionPartialClosing

Gets partition partial closing states. Indicates that a partition has been armed but one or more zones have been bypassed.

Accessibility : Read Only

Type: Array

DSCPartitionSpecialClosing

Gets partition special closing states. Indicates that a partition has been armed by one of the following methods: Quick Arm, Auto Arm, Keyswitch, DLS Software or Wireless Key.

Accessibility : Read Only

Type: Array

DSCZoneAlarmStates

Gets zone alarm states.

Accessibility : Read Only

Type: Array

DSCZoneTamperStates

Gets zone tamper states.

Accessibility : Read Only

Type: Array

DSCZoneFaultStates

Gets zone fault states.

Accessibility : Read Only

Type: Array

DSCZoneOpenStates

Gets zone open states.

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. The checksum will be computed eg. 001 for Status Request, not 00191

Syntax

void SendRawCommand( String command )

Parameters

command : The command data to send.

StatusRequest

Ask for complete status.

Syntax

void StatusRequest( )

Parameters

none

LabelRequest

Ask for labels.

Syntax

void LabelRequest( )

Parameters

none

DisableTimeStamp

Disable time stamp. The Time Stamp feature is not supported by this driver. It has to be turned off. It's off by default.

Syntax

void DisableTimeStamp( )

Parameters

none

DSCArmWithCode ( Number, Number )

Arm a specific partition with code.

Syntax

void DSCArmWithCode( Number areaID, Number userCode )

Parameters

areaID : Partition: 1 to 8

userCode : User code to arm

DSCArmAway ( Number )

Arm away a specific partition. Depending on programming, the system might request user code.

Syntax

void DSCArmAway( Number areaID )

Parameters

areaID : Partition: 1 to 8

DSCArmStay ( Number )

Arm stay a specific partition. Depending on programming, the system might request user code.

Syntax

void DSCArmStay( Number areaID )

Parameters

areaID : Partition: 1 to 8

DSCArmNoEntryDelay ( Number )

Arm with no entry delay a specific partition. Depending on programming, the system might request user code.

Syntax

void DSCArmNoEntryDelay( Number areaID )

Parameters

areaID : Partition: 1 to 8

DSCSendCode ( Number )

Send user code upon system request.

Syntax

void DSCSendCode( Number userCode )

Parameters

userCode : User code

DSCKeyPressed ( String )

This command simulates a keypress on a keypad. Key supported: 0 to 9, *, #, a to e, <, >, =, F, A and P. Be careful with Fire, Ambulance and Panic key.

Syntax

void DSCKeyPressed( String keyPressed )

Parameters

keyPressed : Key Pressed

DSCLongKeyPressed ( String )

This command simulates a keypress and hold on a keypad. Key supported: 0 to 9, *, #, a to e, <, >, =, A, P and F. Be careful with Fire, Ambulance and Panic key.

Syntax

void DSCLongKeyPressed( String keyPressed )

Parameters

keyPressed : Key Pressed

SetPropertyForDuration ( String, TimeSpan, IScriptObject, IScriptObject )

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, IScriptObject, IScriptObject )

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.