User Guide

127
Standard NetLinx API (SNAPI) R 1.8.0
Document Camera Functions (Cont.)
Name Component Channel Level Command Constant Notes
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
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.
cyclePower() IPowerComponent 9 POWER Momentary Function Channel: Cycle power
when channel is activated
setPower(ON) IPowerComponent 27 PWR_ON Momentary Function Channel: Power is
turned on when channel is activated
setPower(OFF) IPowerComponent 28 PWR_OFF Momentary Function Channel: Power is
turned off when channel is activated
setPower(ps) IPowerComponent 255 POWER_ON Discrete Function Channel: Power is on
while channel is active