User Guide

85
Standard NetLinx API (SNAPI) R 1.8.0
Module
Component
Name: Module
Interface: IModuleComponent
IModuleComponent
Component Functions:
Name: Channel: Level: Command: Constant: Notes:
getDebugState() ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for
ERROR, WARNING, DEBUG, INFO
getFWVersion() ?FWVERSION Query for the device firmware version, responds with FWVERSION-<version>
getProperty(key) ?PROPERTY-<key> Query for the value of property <key>, respond with PROPERTY-<key>,<value>
getVersion() ?VERSION Query for the module version, responds with VERSION-<version>
loadProperties(fileName) LOADPROPERTY-<file> Load properties from the file with the supplied filename. Used to load meta-data prop-
erties for modules including Generic IR modules.
passThru(buffer) PASSTHRU-<buffer> Send a message directly to the device
reinitialize() REINIT Reinitialize communication with the device
setDebugState(state) DEBUG-<state> Set the debug state where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO
setDeviceDa-
teTime(date)
CLOCK-<mm/dd/yyyy> <hh:mm:ss> Set the device date/time.
setPassbackOn(bool-
ean)
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) PROPERTY-<key>,<value> Set the value of property <key> to <value>
Listener
Name: Module Listener
Interface: IModuleComponentListener
IModuleComponentListener
Listener Functions:
Name: Channel: Level: Command: Constant: Notes:
processDataInitializedE-
vent
252 DATA_INITIALIZED Feedback Channel: Module data is synchronized with device while channel is on
processDebugEvent DEBUG-<state> Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO
processDeviceOn-
LineEvent
251 DEVICE_COMMUNICATI
NG
Feedback Channel: Communication is established with device while channel is on
processPassbackEvent 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.