Interfacing With Standard Netlinx Api (Snapi); Overview - AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS Instruction Manual

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