Table of Contents
Advertisement
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
3
Advertisement
Table of Contents
