AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS User Manual
Size:
650.15 Kb
Download

instruction manual

Standard NetLinx API (SNAPI) R 1.8.0

Components/Listeners

last revision: 8-29-06Document ID:033-004-2993

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, incidental 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 damages 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 CORPORATION 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 ..........................................................................................................

11

Audio Mixer .....................................................................................................................

13

Audio Processor..............................................................................................................

15

Audio Tape......................................................................................................................

17

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

19

Camera ...........................................................................................................................

21

Dialer...............................................................................................................................

25

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

27

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

29

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

31

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

33

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

35

Disc Device .....................................................................................................................

37

Disc Transport.................................................................................................................

41

Display ............................................................................................................................

45

Document Camera ..........................................................................................................

49

Gain.................................................................................................................................

51

HVAC ..............................................................................................................................

53

Standard NetLinx API (SNAPI) R 1.8.0

1

 

InputOutput Device Component......................................................................................

59

InputOutput .....................................................................................................................

61

IO Device ........................................................................................................................

63

Keypad ............................................................................................................................

65

Lamp ...............................................................................................................................

67

Light ................................................................................................................................

69

Media DB ........................................................................................................................

73

Media Device ..................................................................................................................

75

Menu ...............................................................................................................................

79

Module ............................................................................................................................

85

Monitor ............................................................................................................................

87

Motor ...............................................................................................................................

89

Multi Window...................................................................................................................

91

Output Stream.................................................................................................................

93

Phonebook ......................................................................................................................

95

Pool Spa..........................................................................................................................

97

Power Device Component ............................................................................................

103

Power Device ................................................................................................................

105

Power ............................................................................................................................

107

Pre Amp ........................................................................................................................

109

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

111

Receiver ........................................................................................................................

113

Relay Device Component .............................................................................................

115

Relay Device .................................................................................................................

117

Security System ............................................................................................................

119

Sensor...........................................................................................................................

121

Settop Box.....................................................................................................................

123

 

2

Standard NetLinx API (SNAPI) R 1.8.0

Slide Projector...............................................................................................................

125

Source Select................................................................................................................

127

Switcher ........................................................................................................................

129

Tape Transport..............................................................................................................

131

Text Keypad ..................................................................................................................

135

Tuner Station.................................................................................................................

137

TV..................................................................................................................................

141

Utility .............................................................................................................................

143

VCR...............................................................................................................................

145

Video Conferencer ........................................................................................................

147

Video Processor............................................................................................................

149

Video Projector..............................................................................................................

151

Video Wall .....................................................................................................................

153

Volume Controller .........................................................................................................

155

Volume ..........................................................................................................................

157

Weather.........................................................................................................................

159

Window .........................................................................................................................

163

Standard NetLinx API (SNAPI) R 1.8.0

3

 

 

4

Standard NetLinx API (SNAPI) R 1.8.0

Interfacing with Standard NetLinx API (SNAPI)

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.8.0

1

 

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.

 

2

Standard NetLinx API (SNAPI) R 1.8.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.8.0

3