User Guide

65
Standard NetLinx API (SNAPI) R 1.8.0
Keypad
Component
Name: Keypad
Interface: IKeypadComponent
IKeypadComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
addKeypadCompo-
nent(index,keypadAd-
dress)
KEYPADADD-<index>,<key-
padaddr>
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 module
documentation)
getKeypadComponen-
tAddress(index)
?KEYPADADDR-<index> Query for the address of the keypad at index <index>, responds with KEYPADADDR-
<index>,<keypadaddr>
getKeypadComponentIn-
dex(keypadAddress)
?KEYPADIDX-<keypadaddr> Query for the index of the keypad with address <keypadaddr>, responds with KEY-
PADADDR-<index>,<keypadaddr>
removeKeypadCompo-
nent(index)
KEYPADREMOVEIDX-<index> Remove the keypad at index <index>, where <index> is 1-x and x is the maximum sup-
ported keypad index (see specific module documentation)
removeKeypadCompo-
nent(keypadAddress)
KEYPADREMOVEADDR-<key-
padaddr>
Remove the keypad with address <keypadaddr>, where <keypadaddr> is a keypad
address
setButton-
State(btnNum,bs)
KEYPADBTN-<btn>,<state> Set the state of a keypad button <btn> for the keypad at index/port, where <state> is
CLICK or DOUBLECLICK
setButtonSta-
tus(btnNum,bs)
<btn> Discrete Function Channel: Set the status of a keypad button <btn> for the keypad at
index/port (see state chart)
setButtonSta-
tus(btnNum,bs)
<btn>+100 Discrete Function Channel: Set the status of a keypad button <btn> for the keypad at
index/port (see state chart)
Listener
Name: Keypad Listener
Interface: IKeypadComponentListener
IKeypadComponentListener
Listener Functions:
Name: Channel: Level: Command: Constant: Notes:
processButton-
StateEvent
KEYPADBTN-<btn>,<state> Button State changed. <btn> is button number and <state> is CLICK or DOUBLE-
CLICK
processButton-
StateEvent
<btn> Input Function Channel: Button state is Released when BUTTON_EVENT-RELEASE is
received, where <btn> is the button/channel number
processButton-
StateEvent
<btn> Input Function Channel: Button state is Pushed when BUTTON_EVENT-PUSH is
received, where <btn> is the button/channel number
processButtonStatusEv-
ent
<btn>+100 Feedback Channel: Button status on BLINK while channel <btn> is on and channel
<btn>+100 is on, where <btn> is the button/channel number (see chart below)
processButtonStatusEv-
ent
<btn> Feedback Channel: Button status on ON while channel <btn> is on and channel
<btn>+100 is off, where <btn> is the button/channel number (see chart below)