User Guide

119
Standard NetLinx API (SNAPI) R 1.8.0
Security System
Component
Name: Security System
Interface: ISecuritySystemComponent
ISecuritySystemComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
getPointState(secPoint) ?SECPOINTSTATE-<point> Query for Point State, responds with SECPOINTSTATE-<point>,<state> where <point>
is 1 to the maximum point point as returned by getPointCount() (see specific module
documentation) and <state> is BYPASS or ACTIVE
getPointStatus(secPoint) ?SECPOINTSTATUS-<point> Query for Point Status, responds with SECPOINTSTATUS-<point>,<status> where
<point> is 1 to the maximum point point as returned by getPointCount() (see specific
module documentation) and <status> is ACTIVE, FAULT or BYPASSED
getSecurityState() ?SECSTATE Query for Security State, responds with SECSTATE-<state> where <state> is
ARM_HOME, ARM, ARM_HOME_NOW, ARM_NOW, DISARM, FIRE, PANIC,
POLICE, MEDICAL or NONE
getSecurityStatus() ?SECSTATUS Query for Security Status, responds with SECSTATUS-<status> where <status> is DIS-
ARMED, ARMED_HOME, ARMED, ALARM
isOKToArm() ?SECARMABLE Query for Security arm-able status, responds with SECARMABLE-<status> where
<status> is 1 or 0
setPoint-
State(secPoint,ps,pw)
SECPOINTSTATE-
<point>,<state>,<password>
Set Point State where <point> is 1 to the maximum point point as returned by getPoint-
Count() (see specific module documentation), <state> is ACTIVE or BYPASS and
<password> is the password required to complete the operation (see specific module
documentation).
setSecurityS-
tate(ss,password)
SECSTATE-<state>,<password> Set Security State where <state> is ARM_HOME, ARM, ARM_HOME_NOW,
ARM_NOW, DISARM, FIRE, PANIC, POLICE, MEDICAL and <password> is the pass-
word required to complete the operation (see specific module documentation).
Listener
Name: Security System Listener
Interface: ISecuritySystemComponentListener
ISecuritySystemComponentListener
Listener Functions:
Name: Channel: Level: Command: Constant: Notes:
processOKToArmEvent SECARMABLE-<status> Security arm-able changed, where <status> is 1 or 0, 1 means the security system can
be armed.
processPointStateEvent SECPOINTSTATE-<point>,<state> Point State changed, where <point> is 1 to the maximum point point as returned by get-
PointCount() (see specific module documentation) and <state> is BYPASS or ACTIVE
processPointStatusEvent SECPOINTSTATUS-<point>,<sta-
tus>
Point Status changed, where <point> is 1 to the maximum point point as returned by
getPointCount() (see specific module documentation) and <status> is ACTIVE, FAULT
or BYPASSED
processSecurityS-
tateEvent
SECSTATE-<state> Security State changed, where <state> is ARM_HOME, ARM, ARM_HOME_NOW,
ARM_NOW, DISARM, FIRE, PANIC, POLICE, MEDICAL or NONE