User Guide

145
Standard NetLinx API (SNAPI) R 1.8.0
Light
IKeypadComponent
IKeypadComponentListener
ILightComponent
ILightComponentListener
IModuleComponent
IModuleComponentListener
Name: Light
Interface: ILight
Light Functions
Name Component Channel Level Command Constant Notes
addKeypadComponent(index,keypadAd-
dress)
IKeypadComponent KEYPADADD-
<index>,<keypadaddr>
Add a keypad address at a given index,
where <index> is 1-x and <keypadaddr> is
a keypad address and x is the maximum
supported keypad index (see specific mod-
ule documentation)
getKeypadComponentAddress(index) IKeypadComponent ?KEYPADADDR-
<index>
Query for the address of the keypad at
index <index>, responds with KEY-
PADADDR-<index>,<keypadaddr>
getKeypadComponentIndex(keypadAddress) IKeypadComponent ?KEYPADIDX-<key-
padaddr>
Query for the index of the keypad with
address <keypadaddr>, responds with
KEYPADADDR-<index>,<keypadaddr>
removeKeypadComponent(keypadAddress) IKeypadComponent KEYPA-
DREMOVEADDR-
<keypadaddr>
Remove the keypad with address <key-
padaddr>, where <keypadaddr> is a key-
pad address
removeKeypadComponent(index) IKeypadComponent KEYPADREMOVEIDX-
<index>
Remove the keypad at index <index>,
where <index> is 1-x and x is the maximum
supported keypad index (see specific mod-
ule documentation)
setButtonState(btnNum,bs) IKeypadComponent KEYPADBTN-
<btn>,<state>
Set the state of a keypad button <btn> for
the keypad at index/port, where <state> is
CLICK or DOUBLECLICK
setButtonStatus(btnNum,bs) IKeypadComponent <btn> Discrete Function Channel: Set the status
of a keypad button <btn> for the keypad at
index/port (see state chart)
setButtonStatus(btnNum,bs) IKeypadComponent <btn>+1
00
Discrete Function Channel: Set the status
of a keypad button <btn> for the keypad at
index/port (see state chart)
processButtonStateEvent(PUSH) IKeypadComponentListener <btn> Input Function Channel: Button state is
Released when BUTTON_EVENT-
RELEASE is received, where <btn> is the
button/channel number