User Guide

Standard NetLinx API (SNAPI) R 1.8.0
142
Keypad Functions (Cont.)
Name Component Channel Level Command Constant Notes
processButtonStateEvent(ButtonState) IKeypadComponentListener KEYPADBTN-
<btn>,<state>
Button State changed. <btn> is button
number and <state> is CLICK or DOUBLE-
CLICK
processButtonStatusEvent(ON) IKeypadComponentListener <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)
processButtonStatusEvent(BLINK) IKeypadComponentListener <btn>+1
00
Feedback Channel: Button status on
BLINK while channel <btn> is on and chan-
nel <btn>+100 is on, where <btn> is the
button/channel number (see chart below)
getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with
DEBUG-<state> where <state> is 1-4 for
ERROR, WARNING, DEBUG, INFO
getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version,
responds with FWVERSION-<version>
getProperty(key) IModuleComponent ?PROPERTY-<key> Query for the value of property <key>,
respond with PROPERTY-<key>,<value>
getVersion() IModuleComponent ?VERSION Query for the module version, responds
with VERSION-<version>
loadProperties(fileName) IModuleComponent LOADPROPERTY-
<file>
Load properties from the file with the sup-
plied filename. Used to load meta-data
properties for modules including Generic IR
modules.
passThru(buffer) IModuleComponent PASSTHRU-<buffer> Send a message directly to the device
reinitialize() IModuleComponent REINIT Reinitialize communication with the device
setDebugState(state) IModuleComponent DEBUG-<state> Set the debug state where <state> is 1-4
for ERROR, WARNING, DEBUG, INFO
setDeviceDateTime(date) IModuleComponent CLOCK-<mm/dd/yyyy>
<hh:mm:ss>
Set the device date/time.
setPassbackOn(boolean) IModuleComponent PASSBACK-<state> Set the passback state where <state> is 1
or 0. When passback is on, all response
from the device will be passed back to the
NetLinx program as a string from the virtual
device
setProperty(key,value) IModuleComponent PROPERTY-
<key>,<value>
Set the value of property <key> to <value>
processDataInitializedEvent(boolean) IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel: Module data is syn-
chronized with device while channel is on
processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4
for ERROR, WARNING, DEBUG, INFO
processDeviceOnLineEvent(boolean) IModuleComponentListener 251 DEVICE_COMMUNICATIN
G
Feedback Channel: Communication is
established with device while channel is on