AMX CAFE DUET STANDARD NETLINX API User Manual

instruction manual

Standard NetLinx API

(SNAPI) R 1.8.0

Devices

last revision: 8-29-06

Document ID: 033-004-2994

AMX Limited Warranty and Disclaimer

AMX Corporation warrants its products to be free of defects in material and workmanship under normal use for three (3) years from the date of purchase from

AMX Corporation, with the following exceptions:

• Electroluminescent and LCD Control Panels are warranted for three (3) years, except for the display and touch overlay components that are warranted for a period of one (1) year.

• Disk drive mechanisms, pan/tilt heads, power supplies, MX Series products, and KC Series products are warranted for a period of one (1) year.

• Unless otherwise specified, OEM and custom products are warranted for a period of one (1) year.

• Software is warranted for a period of ninety (90) days.

• Batteries and incandescent lamps are not covered under the warranty.

This warranty extends only to products purchased directly from AMX Corporation or an Authorized AMX Dealer.

AMX Corporation is not liable for any damages caused by its products or for the failure of its products to perform. This includes any lost profits, lost savings, inci-

dental damages, or consequential damages. AMX Corporation is not liable for any claim made by a third party or by an AMX Dealer for a third party.

This limitation of liability applies whether damages are sought, or a claim is made, under this warranty or as a tort claim (including negligence and strict product

liability), a contract claim, or any other claim. This limitation of liability cannot be waived or amended by any person. This limitation of liability will be effective

even if AMX Corporation or an authorized representative of AMX Corporation has been advised of the possibility of any such damages. This limitation of liability,

however, will not apply to claims for personal injury.

Some states do not allow a limitation of how long an implied warranty last. Some states do not allow the limitation or exclusion of incidental or consequential dam-

ages for consumer products. In such states, the limitation or exclusion of the Limited Warranty may not apply. This Limited Warranty gives the owner specific legal

rights. The owner may also have other rights that vary from state to state. The owner is advised to consult applicable state laws for full determination of rights.

EXCEPT AS EXPRESSLY SET FORTH IN THIS WARRANTY, AMX CORPORATION MAKES NO OTHER WARRANTIES, EXPRESSED OR

IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. AMX CORPO-

RATION EXPRESSLY DISCLAIMS ALL WARRANTIES NOT STATED IN THIS LIMITED WARRANTY. ANY IMPLIED WARRANTIES THAT

MAY BE IMPOSED BY LAW ARE LIMITED TO THE TERMS OF THIS LIMITED WARRANTY.

Table of Contents

Interfacing with Standard NetLinx API (SNAPI) .................................................... 1

Overview ........................................................................................................................... 1

Programming..................................................................................................................... 4

Channel and Level Ranges............................................................................................... 6

Commands and Escape Characters ................................................................................. 7

Amplifier ............................................................................................................................ 9

Audio Conferencer .......................................................................................................... 13

Audio Mixer ..................................................................................................................... 25

Audio Processor.............................................................................................................. 31

Audio Tape...................................................................................................................... 37

Audio Tuner Device......................................................................................................... 43

Camera ........................................................................................................................... 49

Digital Media Decoder..................................................................................................... 55

Digital Media Encoder ..................................................................................................... 67

Digital Media Server........................................................................................................ 73

Digital Satellite System ................................................................................................... 89

Digital Video Recorder .................................................................................................... 99

Disc Device ................................................................................................................... 113

Document Camera ........................................................................................................ 125

HVAC ............................................................................................................................ 131

IO Device ...................................................................................................................... 139

Keypad .......................................................................................................................... 141

Light .............................................................................................................................. 145

Monitor .......................................................................................................................... 153

Standard NetLinx API (SNAPI) R 1.8.0

Motor ............................................................................................................................. 165

Multi Window................................................................................................................. 169

Pool Spa........................................................................................................................ 181

Power Device ................................................................................................................ 189

Pre Amp Surround Sound Processor............................................................................ 191

Receiver ........................................................................................................................ 203

Relay Device ................................................................................................................. 217

Security System ............................................................................................................ 219

Sensor Device............................................................................................................... 223

Settop Box..................................................................................................................... 225

Slide Projector............................................................................................................... 237

Switcher ........................................................................................................................ 241

Text Keypad .................................................................................................................. 245

TV.................................................................................................................................. 249

Utility ............................................................................................................................. 265

VCR............................................................................................................................... 267

Video Conferencer ........................................................................................................ 281

Video Processor............................................................................................................ 299

Video Projector.............................................................................................................. 311

Video Wall ..................................................................................................................... 325

Volume Controller ......................................................................................................... 331

Weather......................................................................................................................... 333

Standard NetLinx API (SNAPI) R 1.8.0

Interfacing with Standard NetLinx API (SNAPI)

The Standard NetLinx API (SNAPI) maps function and feedback calls in Duet modules to ICSP channels, levels and commands. SNAPI allows NetLinx

programmers to utilize Duet modules in their NetLinx programs and access the function and feedback of those modules through programming similar to

programming they would use on an AMX device, such as a volume box. While each Duet module may support advanced functions via channels, levels and

commands (see specific module documentation for the channels, levels and commands supported by that module), the SNAPI mappings apply to the Standard API

supported by each module.

Overview

Devices

In Duet, all modules use a Duet virtual device. Duet virtual devices are in the range 41000:1:0 to 42000:1:0. Duet virtual devices are specifically designed for use

with Duet modules. Regular virtual devices will not work properly with Duet modules.

Ports

In Duet, each device may support one or more ports. Multiple ports are used to provide access to different components within the module. For instance, a switcher

may support output volume for each switcher output. In Duet, this is represented by a volume component for each output and in SNAPI, each of these components

is mapped to a Duet virtual device ports. Port 1 will control the volume for output 1, port 2 will control the volume for output 2, etc… Another common use of port

is to control different "zones" of and Audio Receiver, HVAC, Security Systems, etc… It is possible that a single port may offer only a small bit of functionality,

such as volume control.

Port 1 is always the "main" device and supports all functions of the device. For components that have multiple instances, such as volume, port 1 will control the

default component, which is usually component 1.

The documentation for each module will describe what ports are available and what functions they control. See the specific module documentation for a complete

list of ports supported by the module.

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

Channels

In SNAPI, there are four kinds of channels: Input Function Channels, Momentary Function Channels, Discrete Function Channels and Feedback Channels.

Input function channels are used for response type functions, such as when a device wants to inform your program of an interesting event, similar to a button push

on a touch panel. For instance, channel 1 is the input function channel for processButtonStateEvent (). When the module has information about the push or release

of a button, the module will send a PUSH or RELEASE.

Momentary function channels are used for momentary type functions and do not provide discrete feedback. For instance, channel 9 is the momentary function

channel for cyclePower(). When pulsed, the channel cycles the state of power on the device and only provides momentary feedback, i.e. the channel is on only

while this function is activated.

Discrete function channels are used for discrete type functions and usually provide discrete feedback. For instance, channel 255 is the discrete function channel for

setPower(); When turned on, this channel sets the state of the power on the device to on. When turned off, this channel sets the state of the power on the device to

off. This channel provides discrete feedback as well; this channel is on if and only if the state of the power on the device is on. In most cases, the channel is listed

as a Discrete function channel next to the function the channel controls and as a Feedback channel next to the feedback function that controls this channel.

Feedback channels provide discrete feedback only. For instance, channel 251 is the feedback channel of Communication Active. This channel is on if and only if

the module is able to communicate to the device.

Levels

Levels in SNAPI are used for both function and feedback. In some cases, a level is only used for feedback, such as temperature, while some levels are used for

function and feedback, such a volume. In most cases, level ranges are from 0-255. All exceptions to this rule are noted, and are only used when the level range is

not bounded by a minimum and a maximum, such as temperature.

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

Commands

Commands in SNAPI are used for discrete and momentary functions when the function requires textual information, multiple parameters, or the functions are not

commonly used. For instance, Temperature scale is set via a command because this is usually done only once in a control system program. Other functions, such as

adding and removing lighting and keypad addresses, requires more information than a channel or level alone can convey. All commands start with a command

header, followed by a "-" to separate the command from the data, and data arguments are usually separated by ","s.

Commands used to query for the status of a property start with a "?". Query commands cause the module to respond with a response command.

SNAPI.axi

SNAPI.axi is an include file that defines constants for each channel and level defined by SNAPI. These constants can be used in your programs in place of channel

and level numbers. The constant names are listed in this document alongside every SNAPI function assigned to a channel or level.

SNAPI.axi is located in C:\Program Files\Common Files\AMXShare\AXIs. The file is organized by device type and lists all the standard channels and levels that

may be supported by the module. This list does not contain all the channel or levels supported by a module and may include channels and levels not supported by a

device. See the specific module documentation for a complete list of channels and levels supported by the module.

To include SNAPI.axi in your program, simply add an #INCLUDE statement for it:

#INCLUDE 'SNAPI.axi'

The file does not need to be copied to your project directory. The NetLinx compiler will be able to find this file automatically and include it in your program.

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

Programming

Channels

Input function channels are used for response type functions. For instance, channel 1 notifies your program of a button push in the KeypadComponent. When your

program receives a PUSH, the button is pushed. When your program receives a RELEASE, the button is released. You should use BUTTON_EVENT's to capture

the changes of an Input function channel:

BUTTON_EVENT[dvDevice, KEYPAD_BTN] { PUSH: // Button was pushed { } RELEASE: // Button was released { } }

Momentary function channels are used to activate functions when the channels change from an OFF state to an ON state. For instance, channel 9 or the constant

POWER cycles the state of the power on the device when it turns on. No change occurs when the channels change from an ON state to an OFF state. You should

activate Momentary function channels using the PULSE, TO or MIN_TO keywords:

PULSE[dvDevice,POWER]// Cycle the state of power TO[dvDevice,POWER]// Cycle the state of power MIN_TO[dvDevice,POWER]// Cycle the state of power

Discrete function channels are used to activate functions when the channel changes from an OFF state to an ON state and from an ON to an OFF state. For

instance, channel 255 or the constant POWER_ON sets the state of the power on the device when it turns on and off. You should activate discrete function channels

using the ON and OFF keywords, or any syntax that changes the state of the channel such as a feedback assignment:

ON[dvDevice,POWER_ON] // Turn the power on OFF[dvDevice,POWER_ON] // Turn the power off [dvDevice,POWER_ON] = ![dvDevice,POWER_ON] // Cycle the state of power

Feedback channels do not active function and should only be used for feedback. These channels can be used in CHANNEL_EVENTs or feedback assignment

statements to read the status of the channel:

bCommunicationActive = [dvDevce,DEVICE_COMMUNICATING] CHANNEL_EVENT[dvDevice,DEVICE_COMMUNICATING] { ON: ON[bCommunicationActive] OFF: OFF[bCommunicationActive] }

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

Ramping Channels

Some channels in SNAPI provide ramping functionality and some provide adjust "stepping" functionality. Since ramping on a device is only provided if the device

supports ramping, a channel that causes ramping on one device may not cause ramping on another device. The following syntax can be used universally for all

ramping functionality:

BUTTON_EVENT[dvTP,1] { PUSH: TO[dvDevice,VOL_UP] HOLD[3 , REPEAT]: ON[dvDevce,VOL_UP] }

The PUSH: TO part of the button event causes ramping to start and continue until the button is released. If the device does not support ramping, the device adjusts

the desired parameter either up or down one step and stops. The HOLD: ON part of the button event causes the step adjustment to repeat, at a rate specified by the

HOLD repeat time, until the button is released. The HOLD: ON part of the button event has no effect if the device supports ramping.

In a future version of Duet, it is expected that all modules will support ramping natively and that this NetLinx code will not always be required. However, if the

module you are using does not support ramping, this code can be used to achieve ramping functionality.

Levels

Levels in SNAPI are used for both function and feedback. For feedback levels, the level value can be captured in a LEVEL_EVENT, with CREATE_LEVEL or

sent directly to a touch panel display bargraph using DEFINE_CONNECT_LEVEL:

LEVEL_EVENT[dvDevice,1] { // LEVEL.VALUE holds the new level value } CREATE_LEVEL dvDevice,1,nMyVariable // nMyVariable will hold the // latest value of the level DEFINE_CONNECT_LEVEL(dvDevice,1,dvTp,1)

Levels used for functions can be set by calling SEND_LEVEL or by connecting to a touch panel active bargraph using DEFINE_CONNECT_LEVEL:

SEND_LEVEL dvDevice,1,nNewLevelValue DEFINE_CONNECT_LEVEL(dvDevice,1,dvTp,1)

The CREATE_LEVEL/SEND_LEVEL mechanism is recommended for use with SNAPI. While LEVEL_EVENT will work fine, you may experience problems

when a touch panel falls offline and then reconnects, which happens often with wireless panels. LEVEL_EVENT's will only fire when a change of the level value

occurs. When the panel comes online, the only way to reliably update the level is with a SEND_LEVEL.

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

Commands

Commands in SNAPI are sent like commands to other devices, using the SEND_COMMAND keyword:

SEND_COMAND dvDevice,'?VERSION'

Commands used to query for the status of a property start with a "?". Query commands cause the module to respond with a response command. Note that this

response is a command, not a string and can be captured in a DATA_EVENT in the COMMAND sub-section:

DATA_EVENT[dvDevice] { COMMAND: { // DATA.TEXT holds the response to a query command } }

General

The NetLinx program should assume that NetLinx levels are initially 0 and that channels are 'off'. The SNAPI router will notify the NetLinx client upon a change

of state.

All Duet Virtual Devices should be created on port 1, e.g. 41000:1:0 in the following statements:

DEFINE_DEVICE vdvModule = 41000:1:0 dvDevice = 135:1:0 DEFINE_MODULE 'LightModule' LightModule1 (vdvModule , dvDevice )

While it is possible to create a Duet Virtual Device on a port other than 1 and pass it to the Duet module, the behavior of the module is undefined.

Channel and Level Ranges

SNAPI uses only channels in range 1-299. Some channels are used for multiple functions but these channels belong to components that do not overlap within a

single device. For instance, HVAC and Display both use channel 214 for setFanState and setFreezeOn respectively. Some channels are used for the same function

in multiple components, for instance Video Conference and Display both define channel 191 for cyclePIPPosition. In both cases, this is by design.

Some devices may use custom channels for advanced functions. Channels 67-76 and 300-399 are reserved for modules to use for whatever functions they like. See

specific module documentation for details on the channels used in that module.

SNAPI uses Levels in the range 1-48. Some levels are used for the same function in multiple components, for instance HVAC, Pool/Spa and Weather all define

level 34 for Outdoor Temperature. This is by design.

Some device may use custom levels for advanced functions. Levels 50-80 and above are reserved for modules to use for whatever functions they like. See specific

module documentation for details on the levels used in that module.

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

Commands and Escape Characters

SNAPI command uses comma as a parameter separator. If a parameter's value contains a comma, the parameter is escaping using double quotes at the start and end

of the parameter. If a parameter's value contains a double quote character it is escaped with a pair of double quote characters.

The following examples are properly escaped parameter values:

 6

 Hello

 Brown Eyed Girl

 "Morrison, Van"

 "Van ""The Man"" Morrison"

The following examples are improperly escaped parameter values:

 Morrison, Van

 Van "The Man" Morrison

SNAPI.axi includes a few helpful routines to build commands:

 DuetPackCmdHeader(Hdr)

 DuetPackCmdParam(Cmd, Param)

 DuetPackCmdParamArray(Cmd, Params[])

DuetPackCmdHeader is a command using a given command header where Hdr is the command header. DuetPackCmdParam adds a parameter to the command,

escaping the parameter and adding parameter separators as needed; Cmd is the command to which the parameter is added and Param is the parameter to be added.

DuetPackCmdParamArray is similar to DuetPackCmdParam but it takes an array of parameters and adds them to the command. All of these functions return the

updated command.

SNAPI.axi includes a few helpful routines to parse commands as well:

 DuetParseCmdHeader(Cmd)

 DuetParseCmdParam(Cmd)

DuetParseCmdHeader removes and returns the command header from a command. DuetParseCmdParam removes and returns the next parameter from the

command, un-escaping the parameter as needed. Both of these functions return a string containing the command header or the parameter.

Standard NetLinx API (SNAPI) R 1.7.0

Interfacing with Standard NetLinx API (SNAPI)

An example program using these routines is shown below:

// Build a command to be stored in cTestCmd cTestCmd = DuetPackCmdHeader('COMMAND') cTestCmd = DuetPackCmdParam(cTestCmd,'Morrison,Van') cTestCmd = DuetPackCmdParam(cTestCmd,'Wild Nights') cTestCmd = DuetPackCmdParam(cTestCmd,'"The Man"') cTestCmd = DuetPackCmdParam(cTestCmd,'Tupelo Honey')

// Resulting command is: // 'COMMAND-"Morrison, Van",Wild Nights,""The Man"",Tupelo Honey'

// Remove the parameters for this command cCmdheader = DuetParseCmdHeader(cTestCmd) SWITCH (cCmdheader) {

CASE 'COMMAND': {

cParam1 = DuetParseCmdParam(cTestCmd) cParam2 = DuetParseCmdParam(cTestCmd) cParam3 = DuetParseCmdParam(cTestCmd) cParam4 = DuetParseCmdParam(cTestCmd)

// cParam1 = 'Morrison, Van' // cParam2 = 'Wild Nights' // cParam3 = '"The Man"' // cParam4 = 'Tupelo Honey'

}

Standard NetLinx API (SNAPI) R 1.7.0

Amplifier

IAmplifierComponent IAmplifierComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener

Name: Amplifier

Interface: IAmplifier

Amplifier Functions

Name Component Channel Level Command Constant Notes

getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with

getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version,

getProperty(key) IModuleComponent ?PROPERTY-<key> Query for the value of property <key>,

getVersion() IModuleComponent ?VERSION Query for the module version, responds

loadProperties(fileName) IModuleComponent LOADPROPERTY-

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

setDeviceDateTime(date) IModuleComponent CLOCK-<mm/dd/yyyy>

setPassbackOn(boolean) IModuleComponent PASSBACK-<state> Set the passback state where <state> is 1

setProperty(key,value) IModuleComponent PROPERTY-

processDataInitializedEvent(boolean) IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel: Module data is syn-

<file>

<hh:mm:ss>

DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO

responds with FWVERSION-<version>

respond with PROPERTY-<key>,<value>

with VERSION-<version>

Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules.

for ERROR, WARNING, DEBUG, INFO

Set the device date/time.

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>

chronized with device while channel is on

Standard NetLinx API (SNAPI) R 1.8.0

Amplifier Functions (Cont.)

Name Component Channel Level Command Constant Notes

processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4

processDeviceOnLineEvent(boolean) IModuleComponentListener 251 DEVICE_COMMUNICATINGFeedback Channel: Communication is

processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received

cyclePower() IPowerComponent 9 POWER Momentary Function Channel: Cycle power

setPower(ON) IPowerComponent 27 PWR_ON Momentary Function Channel: Power is

setPower(OFF) IPowerComponent 28 PWR_OFF Momentary Function Channel: Power is

setPower(ps) IPowerComponent 255 POWER_ON Discrete Function Channel: Power is on

setPowerSensor(nld,nIOChan) IPowerComponent IOLINK-<dps>,<chan-

processPowerEvent(ON) IPowerComponentListener 255 POWER_FB Feedback Channel: Power state changed,

cycleVolumeMute() IVolumeComponent 26 VOL_MUTE Momentary Function Channel: Cycle vol-

cycleVolumePreset() IVolumeComponent 138 VOL_PRESET Momentary Function Channel: Cycle cam-

getVolumePreset() IVolumeComponent ?VOLPRESET Query for volume preset, responds with

saveVolumePreset(preset) IVolumeComponent VOLPRESETSAVE-

setVolume(level) IVolumeComponent 1 VOL_LVL Set volume, range is 0-255

setVolumeMuteOn(state) IVolumeComponent 199 VOL_MUTE_ON Discrete Function Channel: Volume mute is

setVolumePreset(preset) IVolumeComponent VOLPRESET-<preset> Recall volume preset where <preset> is 1

setVolumeRamp(UP) IVolumeComponent 24 VOL_UP Ramping Channel: Volume is ramped up

setVolumeRamp(DOWN) IVolumeComponent 25 VOL_DN Ramping Channel: Volume is ramped

nel>

for ERROR, WARNING, DEBUG, INFO

established with device while channel is on

form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device.

when channel is activated

turned on when channel is activated

turned off when channel is activated

while channel is active

Associate a Power Sensor with the device where <dps> is the DPS in string form, i.e. 17:1:0, and <channel> is the channel on the IO device to which the power sensor is connected.

power is on while channel is on

ume mute when channel is activated

era preset when channel is activated

VOLPRESET-<preset>

Save Volume Preset where <preset> is 1 to x and x is the maximum supported preset (see specific module documentation)

on while channel is active

to x and x is the maximum supported preset (see specific module documentation)

while channel is active

down while channel is active

Standard NetLinx API (SNAPI) R 1.8.0

Amplifier Functions (Cont.)

Name Component Channel Level Command Constant Notes

processVolumeEvent(int) IVolumeComponentListener 1 VOL_LVL Volume changed, range is 0-255

processVolumeMuteEvent(boolean) IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel: Volume is muted if

processVolumePresetEvent(int) IVolumeComponentListener VOLPRESET-<preset> Volume preset changed, where <preset> is

processVolumeRampEvent(UP) IVolumeComponentListener 24 VOL_UP_FB Feedback Channel: Volume is ramping up

processVolumeRampEvent(DOWN) IVolumeComponentListener 25 VOL_DN_FB Feedback Channel: Volume is ramping

channel is on

1-x and x is the maximum supported preset (see specific module documentation)

while channel is on

down while channel is on

Amplifier State Charts

State Channel 255

OFF OFF ON ON

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer

IAudioConferencerComponent IAudioConferencerComponentListener IDialerComponent IDialerComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPhonebookComponent IPhonebookComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener

Name: Audio Conferencer

Interface: IAudioConferencer

Audio Conferencer Functions

Name Component Channel Level Command Constant Notes

cyclePrivacy() IAudioConferencerComponent 145 ACONF_PRIVACY Momentary Function Channel: Cycle pri-

setPrivacyOn(state) IAudioConferencerComponent 146 ACONF_PRIVACY_ON Discrete Function Channel: Privacy is on

train() IAudioConferencerComponent 147 ACONF_TRAIN Momentary Function Channel: Train is exe-

processPrivacyEvent(boolean) IAudioConferencerComponentListener 146 ACONF_PRIVACY_FB Feedback Channel: Privacy is muted if

cycleAudibleRing() IDialerComponent 205 DIAL_AUDIBLE_RING Momentary Function Channel: Cycle audi-

cycleAutoAnswer() IDialerComponent 204 DIAL_AUTO_ANSWER Momentary Function Channel: Cycle auto

cycleOffHook() IDialerComponent 202 DIAL_OFF_HOOK Momentary Function Channel: Cycle hook

dial(recordID) IDialerComponent DIALID-<id> Dial a speed dial record, where <id> is a

dial(index) IDialerComponent DIALINDEX-<index> Dial a speed dial index, where <index> is 1

dialDTMF(char) IDialerComponent DTMF-<digit> Send a DTMF tone for a character without

vacy when channel is activated

while channel is active

cuted when the channel is activated

channel is on

ble ring when channel is activated

answer when channel is activated

state when channel is activated

record id returned by a speed dial search.

to x and x is the maximum supported speed dial index (see specific module documentation)

regard for hook status

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

dialNumber(number) IDialerComponent DIALNUMBER-<num-

flashHook() IDialerComponent 208 DIAL_FLASH_HOOK Momentary Function Channel: Flash hook

getDialerStatus() IDialerComponent ?DIALERSTATUS Querydialer status, responds with DIALER-

redial() IDialerComponent 201 DIAL_REDIAL Momentary Function Channel: Redial when

setAudibleRingOn(state) IDialerComponent 240 DIAL_AUDIBLE_RING_ON Discrete Function Channel: Audible ring is

setAutoAnswerOn(state) IDialerComponent 239 DIAL_AUTO_ANSWER_ON Discrete Function Channel: Auto answer is

setOffHook(state) IDialerComponent 238 DIAL_OFF_HOOK_ON Discrete Function Channel: Hook state is

processAudibleRingOnEvent(boolean) IDialerComponentListener 240 DIAL_AUDIBLE_RING_FB Feedback Channel: Audible ring is on if

processAutoAnswerOnEvent(boolean) IDialerComponentListener 239 DIAL_AUTO_ANSWER_FB Feedback Channel: Auto answer is on if

processDialerStatusEvent(BUSY) IDialerComponentListener DIALERSTATUS-

processDialerStatusEvent(CONNECTED) IDialerComponentListener DIALERSTATUS-CON-

processDialerStatusEvent(DIALING) IDialerComponentListener DIALERSTATUS-

processDialerStatusEvent(DISCONNECTED) IDialerComponentListener DIALERSTATUS-DIS-

processDialerStatusEvent(FAULT) IDialerComponentListener DIALERSTATUS-

processDialerStatusEvent(NEGOTIATING) IDialerComponentListener DIALERSTATUS-

processDialerStatusEvent(RINGING) IDialerComponentListener DIALERSTATUS-

processIncomingCallEvent (String) IDialerComponentListener INCOMINGCALL-

processOffHookEvent(boolean) IDialerComponentListener 238 DIAL_OFF_HOOK_FB Feedback Channel: Hook state is off hook

moveMenuCursor(UP) IMenuComponent 45 MENU_UP Momentary Function Channel: Move menu

ber>

BUSY

NECTED

DIALING

CONNECTED

FAU LT

NEGOTIATING

RINGING

Dial a number where <number> is the number to be dialed.

when channel is activated

STATUS-<status>, where <status> is DIALING,BUSY,RINGING,DISCONNECTED,NEGOTIATING,FAULT,CONNECTED

channel is activated

on while channel is active

off hook while channel is active

channel is on

Dialer status changed, number being dialed is busy

Dialer status changed, dialer is connected

Dialer status changed, dialer is dialing

Dialer status changed, dialer is disconnected/idel

Dialer status changed, dialer encounter a fault during dialing/negotiating

Dialer status changed, dialer is negotiating

Dialer status changed, number being dialed is ringing

An incoming call is detected. If available via caller ID, the phone number will be supplied

if channel is on

cursor UP

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

moveMenuCursor(DOWN) IMenuComponent 46 MENU_DN Momentary Function Channel: Move menu

moveMenuCursor(LEFT) IMenuComponent 47 MENU_LT Momentary Function Channel: Move menu

moveMenuCursor(RIGHT) IMenuComponent 48 MENU_RT Momentary Function Channel: Move menu

moveMenuCursor(UP_LEFT) IMenuComponent 51 MENU_UP_LT Momentary Function Channel: Move menu

moveMenuCursor(UP_RIGHT) IMenuComponent 52 MENU_UP_RT Momentary Function Channel: Move menu

moveMenuCursor(DOWN_LEFT) IMenuComponent 53 MENU_DN_LT Momentary Function Channel: Move menu

moveMenuCursor(DOWN_RIGHT) IMenuComponent 54 MENU_DN_RT Momentary Function Channel: Move menu

pressMenuButton(DIGIT_0) IMenuComponent 10 DIGIT_0 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_1) IMenuComponent 11 DIGIT_1 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_2) IMenuComponent 12 DIGIT_2 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_3) IMenuComponent 13 DIGIT_3 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_4) IMenuComponent 14 DIGIT_4 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_5) IMenuComponent 15 DIGIT_5 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_6) IMenuComponent 16 DIGIT_6 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_7) IMenuComponent 17 DIGIT_7 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_8) IMenuComponent 18 DIGIT_8 Momentary Function Channel: Press menu

pressMenuButton(DIGIT_9) IMenuComponent 19 DIGIT_9 Momentary Function Channel: Press menu

pressMenuButton(PLUS_10) IMenuComponent 20 MENU_PLUS_10 Momentary Function Channel: Press menu

pressMenuButton(ENTER) IMenuComponent 21 MENU_ENTER Momentary Function Channel: Press menu

pressMenuButton(CANCEL) IMenuComponent 43 MENU_CANCEL Momentary Function Channel: Press menu

cursor DOWN

cursor LEFT

cursor RIGHT

cursor UP_LEFT

cursor UP_RIGHT

cursor DOWN_LEFT

cursor DOWN_RIGHT

button DIGIT_0

button DIGIT_1

button DIGIT_2

button DIGIT_3

button DIGIT_4

button DIGIT_5

button DIGIT_6

button DIGIT_7

button DIGIT_8

button DIGIT_9

button PLUS_10

button ENTER

button CANCEL

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

pressMenuButton(MENU) IMenuComponent 44 MENU_FUNC Momentary Function Channel: Press menu

pressMenuButton(EXIT) IMenuComponent 50 MENU_EXIT Momentary Function Channel: Press menu

pressMenuButton(VIDEO) IMenuComponent 57 MENU_VIDEO Momentary Function Channel: Press menu

pressMenuButton(THUMBS_DOWN) IMenuComponent 58 MENU_THUMBS_DN Momentary Function Channel: Press menu

pressMenuButton(THUMBS_UP) IMenuComponent 59 MENU_THUMBS_UP Momentary Function Channel: Press menu

pressMenuButton(ACCEPT) IMenuComponent 60 MENU_ACCEPT Momentary Function Channel: Press menu

pressMenuButton(REJECT) IMenuComponent 61 MENU_REJECT Momentary Function Channel: Press menu

pressMenuButton(LIVE_TV) IMenuComponent 62 MENU_LIVE_TV Momentary Function Channel: Press menu

pressMenuButton(SLEEP) IMenuComponent 63 MENU_SLEEP Momentary Function Channel: Press menu

pressMenuButton(PPV) IMenuComponent 64 MENU_PPV Momentary Function Channel: Press menu

pressMenuButton(FUNCTION) IMenuComponent 65 MENU_FUNCTION Momentary Function Channel: Press menu

pressMenuButton(SETUP) IMenuComponent 66 MENU_SETUP Momentary Function Channel: Press menu

pressMenuButton(XM) IMenuComponent 77 MENU_XM Momentary Function Channel: Press menu

pressMenuButton(FM) IMenuComponent 78 MENU_FM Momentary Function Channel: Press menu

pressMenuButton(AM) IMenuComponent 79 MENU_AM Momentary Function Channel: Press menu

pressMenuButton(CLEAR) IMenuComponent 80 MENU_CLEAR Momentary Function Channel: Press menu

pressMenuButton(BACK) IMenuComponent 81 MENU_BACK Momentary Function Channel: Press menu

pressMenuButton(FORWARD) IMenuComponent 82 MENU_FORWARD Momentary Function Channel: Press menu

pressMenuButton(ADVANCE) IMenuComponent 83 MENU_ADVANCE Momentary Function Channel: Press menu

pressMenuButton(DIMMER) IMenuComponent 84 MENU_DIMMER Momentary Function Channel: Press menu

button MENU

button EXIT

button VIDEO

button THUMBS_DOWN

button THUMBS_UP

button ACCEPT to answer an incoming call

button REJECT to reject an incoming call

button LIVE_TV

button SLEEP

button PPV

button FUNCTION

button SETUP

button XM

button FM

button AM

button CLEAR

button BACK

button FORWARD

button ADVANCE

button DIMMER

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

pressMenuButton(HOLD) IMenuComponent 85 MENU_HOLD Momentary Function Channel: Press menu

pressMenuButton(LIST) IMenuComponent 86 MENU_LIST Momentary Function Channel: Press menu

pressMenuButton(LEFT_PAREN) IMenuComponent 87 MENU_LT_PAREN Momentary Function Channel: Press menu

pressMenuButton(RIGHT_PAREN) IMenuComponent 88 MENU_RT_PAREN Momentary Function Channel: Press menu

pressMenuButton(UNDER_SCORE) IMenuComponent 89 MENU_UNDERSCORE Momentary Function Channel: Press menu

pressMenuButton(DASH) IMenuComponent 90 MENU_DASH Momentary Function Channel: Press menu

pressMenuButton(ASTERISK) IMenuComponent 91 MENU_ASTERISK Momentary Function Channel: Press menu

pressMenuButton(DOT) IMenuComponent 92 MENU_DOT Momentary Function Channel: Press menu

pressMenuButton(POUND) IMenuComponent 93 MENU_POUND Momentary Function Channel: Press menu

pressMenuButton(COMMA) IMenuComponent 94 MENU_COMMA Momentary Function Channel: Press menu

pressMenuButton(DIAL) IMenuComponent 95 MENU_DIAL Momentary Function Channel: Press menu

pressMenuButton(CONFERENCE) IMenuComponent 96 MENU_CONFERENCE Momentary Function Channel: Press menu

pressMenuButton(PLUS_100) IMenuComponent 97 MENU_PLUS_100 Momentary Function Channel: Press menu

pressMenuButton(PLUS_1000) IMenuComponent 98 MENU_PLUS_1000 Momentary Function Channel: Press menu

pressMenuButton(DISPLAY) IMenuComponent 99 MENU_DISPLAY Momentary Function Channel: Press menu

pressMenuButton(SUBTITLE) IMenuComponent 100 MENU_SUBTITLE Momentary Function Channel: Press menu

pressMenuButton(INFO) IMenuComponent 101 MENU_INFO Momentary Function Channel: Press menu

pressMenuButton(FAVORITES) IMenuComponent 102 MENU_FAVORITES Momentary Function Channel: Press menu

pressMenuButton(CONTINUE) IMenuComponent 103 MENU_CONTINUE Momentary Function Channel: Press menu

pressMenuButton(RETURN) IMenuComponent 104 MENU_RETURN Momentary Function Channel: Press menu

button HOLD

button LIST

button LEFT_PAREN

button RIGHT_PAREN

button UNDER_SCORE

button DASH

button ASTERISK

button DOT

button POUND

button COMMA

button DIAL

button CONFERENCE

button PLUS_100

button PLUS_1000

button DISPLAY

button SUBTITLE

button INFO

button FAVORITES

button CONTINUE

button RETURN

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

pressMenuButton(GUIDE) IMenuComponent 105 MENU_GUIDE Momentary Function Channel: Press menu

pressMenuButton(PAGE_UP) IMenuComponent 106 MENU_PAGE_UP Momentary Function Channel: Press menu

pressMenuButton(PAGE_DOWN) IMenuComponent 107 MENU_PAGE_DN Momentary Function Channel: Press menu

pressMenuButton(DECK_A_B) IMenuComponent 108 MENU_DECK_A_B Momentary Function Channel: Press menu

pressMenuButton(TV_VCR) IMenuComponent 109 MENU_TV_VCR Momentary Function Channel: Press menu

pressMenuButton(RECORD_SPEED) IMenuComponent 110 MENU_RECORD_SPEED Momentary Function Channel: Press menu

pressMenuButton(PROGRAM) IMenuComponent 111 MENU_PROGRAM Momentary Function Channel: Press menu

pressMenuButton(AB_REPEAT) IMenuComponent 112 MENU_AB_REPEAT Momentary Function Channel: Press menu

pressMenuButton(HELP) IMenuComponent 113 MENU_HELP Momentary Function Channel: Press menu

pressMenuButton(TITLE) IMenuComponent 114 MENU_TITLE Momentary Function Channel: Press menu

pressMenuButton(TOP_MENU) IMenuComponent 115 MENU_TOP_MENU Momentary Function Channel: Press menu

pressMenuButton(ZOOM) IMenuComponent 116 MENU_ZOOM Momentary Function Channel: Press menu

pressMenuButton(ANGLE) IMenuComponent 117 MENU_ANGLE Momentary Function Channel: Press menu

pressMenuButton(AUDIO) IMenuComponent 118 MENU_AUDIO Momentary Function Channel: Press menu

pressMenuButton(PREVIEW_INPUT) IMenuComponent 129 MENU_PREVIEW_INPUT Momentary Function Channel: Press menu

pressMenuButton(SEND_INPUT) IMenuComponent 130 MENU_SEND_INPUT Momentary Function Channel: Press menu

pressMenuButton(SEND_GRAPHICS) IMenuComponent 131 MENU_SEND_GRAPHICS Momentary Function Channel: Press menu

pressMenuButton(FLASH) IMenuComponent 203 MENU_FLASH Momentary Function Channel: Press menu

pressMenuButton(RESET) IMenuComponent 215 MENU_RESET Momentary Function Channel: Press menu

pressMenuButton(INSTANT_REPLAY) IMenuComponent 218 MENU_INSTANT_REPLAY Momentary Function Channel: Press menu

pressMenuButton(A) IMenuComponent ALPHA-A Press menu button A

button GUIDE

button PAGE_UP

button PAGE_DOWN

button DECK_A_B

button TV_VCR

button RECORD_SPEED

button PROGRAM

button AB_REPEAT

button HELP

button TITLE

button TOP_MENU

button ZOOM

button ANGLE

button AUDIO

button PREVIEW_INPUT

button SEND_INPUT

button SEND_GRAPHICS

button FLASH

button RESET

button INSTANT_REPLAY

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

pressMenuButton(B) IMenuComponent ALPHA-B Press menu button B

pressMenuButton(C) IMenuComponent ALPHA-C Press menu button C

pressMenuButton(D) IMenuComponent ALPHA-D Press menu button D

pressMenuButton(E) IMenuComponent ALPHA-E Press menu button E

pressMenuButton(F) IMenuComponent ALPHA-F Press menu button F

pressMenuButton(G) IMenuComponent ALPHA-G Press menu button G

pressMenuButton(H) IMenuComponent ALPHA-H Press menu button H

pressMenuButton(I) IMenuComponent ALPHA-I Press menu button I

pressMenuButton(J) IMenuComponent ALPHA-J Press menu button J

pressMenuButton(K) IMenuComponent ALPHA-K Press menu button K

pressMenuButton(L) IMenuComponent ALPHA-L Press menu button L

pressMenuButton(M) IMenuComponent ALPHA-M Press menu button M

pressMenuButton(N) IMenuComponent ALPHA-N Press menu button N

pressMenuButton(O) IMenuComponent ALPHA-O Press menu button O

pressMenuButton(P) IMenuComponent ALPHA-P Press menu button P

pressMenuButton(Q) IMenuComponent ALPHA-Q Press menu button Q

pressMenuButton(R) IMenuComponent ALPHA-R Press menu button R

pressMenuButton(S) IMenuComponent ALPHA-S Press menu button S

pressMenuButton(T) IMenuComponent ALPHA-T Press menu button T

pressMenuButton(U) IMenuComponent ALPHA-U Press menu button U

pressMenuButton(V) IMenuComponent ALPHA-V Press menu button V

pressMenuButton(W) IMenuComponent ALPHA-W Press menu button W

pressMenuButton(X) IMenuComponent ALPHA-X Press menu button X

pressMenuButton(Y) IMenuComponent ALPHA-Y Press menu button Y

pressMenuButton(Z) IMenuComponent ALPHA-Z Press menu button Z

selectMenuItem() IMenuComponent 49 MENU_SELECT Momentary Function Channel: Select cur-

getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with

getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version,

getProperty(key) IModuleComponent ?PROPERTY-<key> Query for the value of property <key>,

getVersion() IModuleComponent ?VERSION Query for the module version, responds

rent menu item

DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO

responds with FWVERSION-<version>

respond with PROPERTY-<key>,<value>

with VERSION-<version>

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

loadProperties(fileName) IModuleComponent LOADPROPERTY-

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

setDeviceDateTime(date) IModuleComponent CLOCK-<mm/dd/yyyy>

setPassbackOn(boolean) IModuleComponent PASSBACK-<state> Set the passback state where <state> is 1

setProperty(key,value) IModuleComponent PROPERTY-

processDataInitializedEvent(boolean) IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel: Module data is syn-

processDebugEvent(int) IModuleComponentListener DEBUG-<state> Debug state changed where <state> is 1-4

processDeviceOnLineEvent(boolean) IModuleComponentListener 251 DEVICE_COMMUNICATINGFeedback Channel: Communication is

processPassbackEvent(byte[]) IModuleComponentListener When passback is on, each string received

closeSearchDB(searchHandle) IPhonebookComponent PHONEBOOKCLOS-

deleteRecord(recordID) IPhonebookComponent PHONEBOOKDE-

getPhonebookCapacity() IPhonebookComponent ?PHONEBOOKCA-

<file>

<hh:mm:ss>

ESEARCH-<key>

LETE-<id>

PA CI T Y

Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules.

for ERROR, WARNING, DEBUG, INFO

Set the device date/time.

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>

chronized with device while channel is on

for ERROR, WARNING, DEBUG, INFO

established with device while channel is on

form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device.

Close the search associated with search key = <key>

Delete phonebook record with index/id of <id>

Query for the phonebook capacity. Responds with PHONEBOOKCAPACITY<count> where count is 1 to x and x is the maximum supported phonebook index (see specific module documentation)

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

queryDB(si) IPhonebookComponent PHONEBOOKNEXT-

queryDB(si) IPhonebookComponent PHONEBOOKPREV-

queryDB(si) IPhonebookComponent PHONEBOOKRE-

searchDB(sr) IPhonebookComponent PHONEBOOK-

<key>[,<count>,<position>]

<key>[,<count>]

FRESH<key>[,<count>]

SEARCH<key>,ID=<id>

Request next <count> records starting with record <position> for the phonebook search associated with search key <key>. If <count> is not present, it is assumed to be 1. If <position> is not present, it is assumed th be the next record in the search result set based on the last PHONEBOOKNEXT or PHONEBOOKPREV command. Responses with PHONEBOOKNEXT-<key>,<count>,<position> where <key> is the search key, <count> is the number of records to expect and <position> is the position of the first record to be returned between 1 through the total number of records.

Request previous <count> records for the phonebook search associated with search key <key>. If <count> is not present, it is assumed to be 1. Responses with PHONEBOOKPREV<key>,<count>,<position> where <key> is the search key, <count> is the number of records to expect and <position> is the position of the first record to be returned between 1 through the total number of records.

Refresh <count> records starting with the last starting position used with a PHONEBOOKNEXT or PHONEBOOKPREV command for the phonebook search associated with search key <key>. If <count> is not present, it is assumed to be 1. Responses with PHONEBOOKNEXT<key>,<count>,<position> where <key> is the search key, <count> is the number of records to expect and <position> is the position of the first record to be returned between 1 through the total number of records.

Search the phonebook database for records with ID equal to <id>. If <id> is "*", all records are returned. <key> is a search key used in other search operations, such as closeSearchDB(). It can be any string you like, such as a panel device number or internal key that makes sense for your program. All future DB operation associated with this search will reference this key value.

Standard NetLinx API (SNAPI) R 1.8.0

Audio Conferencer Functions (Cont.)

Name Component Channel Level Command Constant Notes

updateRecord(sdr) IPhonebookComponent PHONEBOOKUP-

processCloseEvent(String) IPhonebookComponentListener PHONEBOOKCLOS-

processDeleteRecordEvent(boolean,String) IPhonebookComponentListener PHONEBOOKDE-

processEndOfSetEvent(String) IPhonebookComponentListener PHONEBOOKEND-

processQueryDBEvent(PhonebookRecord) IPhonebookComponentListener PHONE-

processSearchDBEvent(PhonebookSearchSet)

processStartOfSetEvent(String) IPhonebookComponentListener PHONEBOOKSTART-

processUpdateRecordEvent(boolean,String) IPhonebookComponentListener PHONEBOOKUP-

cyclePower() IPowerComponent 9 POWER Momentary Function Channel: Cycle power

setPower(ON) IPowerComponent 27 PWR_ON Momentary Function Channel: Power is

setPower(OFF) IPowerComponent 28 PWR_OFF Momentary Function Channel: Power is

setPower(ps) IPowerComponent 255 POWER_ON Discrete Function Channel: Power is on

setPowerSensor(nld,nIOChan) IPowerComponent IOLINK-<dps>,<chan-

processPowerEvent(ON) IPowerComponentListener 255 POWER_FB Feedback Channel: Power state changed,

cycleVolumeMute() IVolumeComponent 26 VOL_MUTE Momentary Function Channel: Cycle vol-

IPhonebookComponentListener PHONEBOOK-

DATE<id>,<name>,<number>

ESEARCH-<key>

LETE-<id>,<success>

<key>

BOOKRECORD<key>,<id>,<#>,<name >,<number>

SEARCHRESULT<key>,<count>

<key>

DATE-<id>,<success>

nel>

Update phonebook record with index/id of <id>, where <name> is the new name and <number> is the new number

The search associated with search key <key> have been closed. No more operations can be performed against this search.

Phonebook record with index/id of <id> was deleted if <success> is 1, otherwise delete failed.

End of search set was reached for search with search key <key>

Phonebook record for search with search key <key>. <id> is the record ID, <#> is the record position from 1 to the total number of records, <name> is the name/label and <number> is the phone number.

Phonebook search results are available for search with search key <key>. <count> is the total count of records. Use PHONEBOOKNEXT and PHONEBOOKPREV to get more records.

Beginning of search set was reached for search with search key <key>

Phonebook record with index/id of <id> was updated if <success> is 1, otherwise update failed.

when channel is activated

turned on when channel is activated

turned off when channel is activated

while channel is active

Associate a Power Sensor with the device where <dps> is the DPS in string form, i.e. 17:1:0, and <channel> is the channel on the IO device to which the power sensor is connected.

power is on while channel is on

ume mute when channel is activated

Standard NetLinx API (SNAPI) R 1.8.0