User Guide

247
Standard NetLinx API (SNAPI) R 1.8.0
Text Keypad State Charts
Text Keypad Functions (Cont.)
Name Component Channel Level Command Constant Notes
processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4
for ERROR, WARNING, DEBUG, INFO
processDeviceOnLineEvent(boolean) IModuleComponentListener 251 DEVICE_COMMUNICATING Feedback Channel: Communication is
established with device while channel is on
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.
clearDisplay() ITextKeypadComponent TEXT- Clear display. "-" is optional
setBacklightOn(state) ITextKeypadComponent TEXTBACKLIGHT-
<state>
Set BacklightOn where (see specific mod-
ule documentation)
setText(line,column,text) ITextKeypadComponent TEXT-<line>,<col-
umn>,<text>
Set text starting at a given line and column.
Characters will be overwritten as needed
based on text. Text will not wrap around to
the next line.
setTextDisplay(text) ITextKeypadComponent TEXT-<text> Set text starting at line 1 and column 1.
Text will wrap around to the next line to fill
the display.
setTextLine(line,text) ITextKeypadComponent TEXT-<line>,<text> Set text starting at column 1 of the line
specified. Text will not wrap around to the
next line.
processButtonStateEvent
State Channel <btn>
RELEASE OFF
PUSH ON
processButtonStatusEvent
State Channel <btn> Channel <btn>+100
OFF OFF OFF
ON ON OFF
BLINK ON ON
Note: All Keypad commands include an index. This index is used to obtain the keypad component and the function is called on that component. The range for channel '<btn>' is 1 to
100; the corresponding range for channel '<btn> + 100' is 101 to 200. Channels above 200 are passed to the module for advanced processing.