Module - AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS Instruction Manual

Module

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