User Guide

Standard NetLinx API (SNAPI) R 1.8.0
220
Security System Functions (Cont.)
Name Component Channel Level Command Constant Notes
processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received
form the device is sent to the NetLinx pro-
gram as a string. Use a DATA_EVENT
event with a STRING handler to caputre
the data from the device.
getPointState(secPoint) ISecuritySystemComponent ?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) ISecuritySystemComponent ?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 <sta-
tus> is ACTIVE, FAULT or BYPASSED
getSecurityState() ISecuritySystemComponent ?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() ISecuritySystemComponent ?SECSTATUS Query for Security Status, responds with
SECSTATUS-<status> where <status> is
DISARMED, ARMED_HOME, ARMED,
ALARM
isOKToArm() ISecuritySystemComponent ?SECARMABLE Query for Security arm-able status,
responds with SECARMABLE-<status>
where <status> is 1 or 0
setPointState(secPoint,ps,pw) ISecuritySystemComponent SECPOINTSTATE-
<point>,<state>,<pass-
word>
Set Point State where <point> is 1 to the
maximum point point as returned by get-
PointCount() (see specific module docu-
mentation), <state> is ACTIVE or BYPASS
and <password> is the password required
to complete the operation (see specific
module documentation).
setSecurityState(ss,password) ISecuritySystemComponent 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
password required to complete the opera-
tion (see specific module documentation).
processOKToArmEvent(boolean) ISecuritySystemComponentListener SECARMABLE-<sta-
tus>
Security arm-able changed, where <sta-
tus> is 1 or 0, 1 means the security system
can be armed.