instruction manual Standard NetLinx API (SNAPI) R 1.8.
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.
Table of Contents Interfacing with Standard NetLinx API (SNAPI) .................................................... 1 Overview ........................................................................................................................... 1 Programming..................................................................................................................... 4 Channel and Level Ranges ...............................................................................................
InputOutput Device Component ...................................................................................... 59 InputOutput ..................................................................................................................... 61 IO Device ........................................................................................................................ 63 Keypad .......................................................................................................................
Slide Projector ............................................................................................................... 125 Source Select ................................................................................................................ 127 Switcher ........................................................................................................................ 129 Tape Transport.....................................................................................................
4 Standard NetLinx API (SNAPI) R 1.8.
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.
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 ().
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.
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.
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.
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.
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.
Interfacing with Standard NetLinx API (SNAPI) An example program using these routines is shown below: // Build cTestCmd cTestCmd cTestCmd cTestCmd cTestCmd a = = = = = command to be stored in cTestCmd DuetPackCmdHeader('COMMAND') DuetPackCmdParam(cTestCmd,'Morrison,Van') DuetPackCmdParam(cTestCmd,'Wild Nights') DuetPackCmdParam(cTestCmd,'"The Man"') DuetPackCmdParam(cTestCmd,'Tupelo Honey') // Resulting command is: // 'COMMAND-"Morrison, Van",Wild Nights,""The Man"",Tupelo Honey' // Remove the parameter
Amplifier Component Name: Amplifier Interface: IAmplifierComponent IAmplifierComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Amplifier Listener Interface: IAmplifierComponentListener IAmplifierComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
10 Standard NetLinx API (SNAPI) R 1.8.
Audio Conferencer Component Name: Audio Conferencer Interface: IAudioConferencerComponent IAudioConferencerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePrivacy() 145 ACONF_PRIVACY Momentary Function Channel: Cycle privacy when channel is activated setPrivacyOn(state) 146 ACONF_PRIVACY_ON Discrete Function Channel: Privacy is on while channel is active train() 147 ACONF_TRAIN Momentary Function Channel: Train is executed when the channel is activated Li
12 Standard NetLinx API (SNAPI) R 1.8.
Audio Mixer Component Name: Audio Mixer Interface: IAudioMixerComponent IAudioMixerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getAudioMixerCrosspoint(input,output) ?XPOINT-,
14 Standard NetLinx API (SNAPI) R 1.8.
Audio Processor Component Name: Audio Processor Interface: IAudioProcessorComponent IAudioProcessorComponent Component Functions: Name: Channel: Level: Command: addAudioProcessorComponent(index,audioProcessorAddress) Constant: AUDIOPROCADD, Notes: Add a Audio Processor object at a given index, where is 1 through x and is the object address and x is the maximum supported index (see specific module documentation) adjustAudioProcessorLevel(1) 24 AUDIOPROC_LEVEL_UP
Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: saveAudioProcessorPreset(preset) AUDIOPROCPRESETSAVE- Save Audio Processor Preset where is 1 to x and x is the maximum supported preset (see specific module documentation) setAudioProcessorCrosspoint(input,output[],value) XPOINT-,,
Audio Tape Component Name: Audio Tape Interface: IAudioTapeComponent IAudioTapeComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAudioTapeRecordMute() 128 CASS_RECORD_MUTE Momentary Function Channel: Cycle record mute when channel is activated cycleAudioTapeSide() 42 CASS_TAPE_SIDE Momentary Function Channel: Cycle tape side when channel is activated reversePlay() 41 CASS_REVERSE_PLAY Momentary Function Channel: Reverse direction of play (but not the side)
18 Standard NetLinx API (SNAPI) R 1.8.
Audio Tuner Device Component Name: Audio Tuner Device Interface: IAudioTunerDeviceComponent IAudioTunerDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Audio Tuner Device Listener Interface: IAudioTunerDeviceComponentListener IAudioTunerDeviceComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
20 Standard NetLinx API (SNAPI) R 1.8.
Camera Component Name: Camera Interface: ICameraComponent ICameraComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAutoFocus() 172 AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() 173 AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated cycleCameraPreset() 177 CAM_PRESET Momentary Function Channel: Cycle camera preset when channel is activated getCameraComponentCount() ?CAMERACOM
Component Functions: (Cont.
Listener Functions: (Cont.
24 Standard NetLinx API (SNAPI) R 1.8.
Dialer Component Name: Dialer Interface: IDialerComponent IDialerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Momentary Function Channel: Cycle audible ring when channel is activated cycleAudibleRing() 205 DIAL_AUDIBLE_RING cycleAutoAnswer() 204 DIAL_AUTO_ANSWER Momentary Function Channel: Cycle auto answer when channel is activated cycleOffHook() 202 DIAL_OFF_HOOK Momentary Function Channel: Cycle hook state when channel is activated dial(index) DIALINDE
Listener Functions: (Cont.
Digital Media Decoder Component Name: Digital Media Decoder Interface: IDigitalMediaDecoderComponent IDigitalMediaDecoderComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Digital Media Decoder Listener Interface: IDigitalMediaDecoderComponentListener IDigitalMediaDecoderComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
28 Standard NetLinx API (SNAPI) R 1.8.
Digital Media Encoder Component Name: Digital Media Encoder Interface: IDigitalMediaEncoderComponent IDigitalMediaEncoderComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Digital Media Encoder Listener Interface: IDigitalMediaEncoderComponentListener IDigitalMediaEncoderComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
30 Standard NetLinx API (SNAPI) R 1.8.
Digital Media Server Component Name: Digital Media Server Interface: IDigitalMediaServerComponent IDigitalMediaServerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Digital Media Server Listener Interface: IDigitalMediaServerComponentListener IDigitalMediaServerComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
32 Standard NetLinx API (SNAPI) R 1.8.
Digital Satellite System Component Name: Digital Satellite System Interface: IDigitalSatelliteSystemComponent IDigitalSatelliteSystemComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Digital Satellite System Listener Interface: IDigitalSatelliteSystemComponentListener IDigitalSatelliteSystemComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (
34 Standard NetLinx API (SNAPI) R 1.8.
Digital Video Recorder Component Name: Digital Video Recorder Interface: IDigitalVideoRecorderComponent IDigitalVideoRecorderComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Digital Video Recorder Listener Interface: IDigitalVideoRecorderComponentListener IDigitalVideoRecorderComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
36 Standard NetLinx API (SNAPI) R 1.8.
Disc Device Component Name: Disc Device Interface: IDiscDeviceComponent IDiscDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Momentary Function Channel: Open or Close the disc tray when the channel is activated cycleDiscTray() 120 DISC_TRAY cycleRandom() 124 DISC_RANDOM Momentary Function Channel: Cycle random when channel is activated cycleRepeat() 125 DISC_REPEAT Momentary Function Channel: Cycle repeat when channel is activated getDiscCapacity() ?DI
Component Functions: (Cont.
Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processTitleInfoEvent TITLEINFO-,,<# of tracks>, Title info changed, where is title number, is a title duration String in the format [-]hh:mm:ss.ff, <# of tracks> is the number of tracks inthis title and is the disc number the title belongs to.
40 Standard NetLinx API (SNAPI) R 1.8.
Disc Transport Component Name: Disc Transport Interface: IDiscTransportComponent IDiscTransportComponent Component Functions: Name: cycleScanSpeed() Channel: Level: Command: 192 Constant: Notes: SCAN_SPEED Momentary Function Channel: Cycles the scan speed when the channel is activated getTrackInfo() ?TRACKINFO Query for the track info, responds with TRACKINFO-,,, where is a String in the format hh:mm:ss.
Listener Name: Disc Transport Listener Interface: IDiscTransportComponentListener IDiscTransportComponentListener Listener Functions: Name: Constant: Notes: processDiscTransportEvent Channel: 243 Level: Command: PAUSE_FB Feedback Channel: Transport state change (see chart below) processDiscTransportEvent 241 PLAY_FB Feedback Channel: Transport state change (see chart below) processDiscTransportEvent 248 RECORD_FB Feedback Channel: Transport state change (see chart below) processDiscTranspo
Disc Transport Listener State Charts processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY ON OFF OFF OFF OFF OFF OFF OFF STOP OFF ON OFF OFF OFF OFF OFF OFF PAUSE OFF OFF ON OFF OFF OFF OFF OFF SCAN_FWD OFF OFF OFF ON OFF OFF OFF OFF SCAN_REV OFF OFF OFF OFF ON OFF OFF OFF RECORD OFF OFF OFF OFF OFF ON OFF OFF RECORD_PAUSE OFF OFF ON OFF OFF ON OFF OFF SLOW_FWD OF
44 Standard NetLinx API (SNAPI) R 1.8.
Display Component Name: Display Interface: IDisplayComponent IDisplayComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Momentary Function Channel: Brightness is incremented when channel is activated adjustBrightness(1) 148 BRIGHT_UP adjustBrightness(-1) 149 BRIGHT_DN Momentary Function Channel: Brightness is decremented when channel is activated adjustColor(1) 150 COLOR_UP Momentary Function Channel: Color is incremented when channel is activated adjustColor(-1
Component Functions: (Cont.
Listener Functions: (Cont.) Name: Channel: processPictureMuteEvent 211 processPIPEvent 195 Level: Command: Constant: Notes: PIC_MUTE_FB Feedback Channel: Picture is muted if channel is on PIP_FB Feedback Channel: PIP is on if channel is on processSharpnessEvent 13 SHARP_LVL Sharpness changed, range is 0-255 processTintEvent 14 TINT_LVL Tint changed, range is 0-255 processVideoTypeEvent Standard NetLinx API (SNAPI) R 1.8.
48 Standard NetLinx API (SNAPI) R 1.8.
Document Camera Component Name: Document Camera Interface: IDocumentCameraComponent IDocumentCameraComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAutoFocus() 172 AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() 173 AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated cycleLight() 176 DOCCAM_LIGHT Momentary Function Channel: Cycle lights when channel is activated setAutoFocusOn(st
Listener Functions: (Cont.
Gain Component Name: Gain Interface: IGainComponent IGainComponent Component Functions: Name: cycleGainMute() Channel: Level: Command: 144 setGain(level) 5 Constant: Notes: GAIN_MUTE Momentary Function Channel: Cycle gain mute when channel is activated GAIN_LVL Set gain, range is 0-255 setGainMuteOn(state) 143 GAIN_MUTE_ON Discrete Function Channel: Gain mute is on while channel is active setGainRamp(DOWN) 141 GAIN_DN Ramping Channel: Gain is ramped down while channel is active setGain
52 Standard NetLinx API (SNAPI) R 1.8.
HVAC Component Name: HVAC Interface: IHVACComponent IHVACComponent Component Functions: Name: Channel: Level: Command: addHVACComponent(index,hvacAddress) Constant: HVACADD-, Notes: Add a thermostat at a given index, where is 1-x and is a thermostat address and x is the maximum supported thermostat index (see specific module documentation) cycleFanState() 213 HVAC_FAN cycleHumidifyState() 217 HVAC_HUMIDIFY_STATE Momentary Function Channel: Cycle the fan s
Component Functions: (Cont.
Listener Functions: (Cont.
Listener Functions: (Cont.
HVAC Listener State Charts processFanStateEvent State Channel 214 Channel 215 ON ON OFF AUTO OFF ON processFanStatusEvent State Channel 216 OFF OFF ON ON processHumidifyStateEvent State Channel 228 Channel 229 Channel 230 Channel 231 AUTO ON OFF OFF OFF DEHUMIDIFY OFF ON OFF OFF HUMIDIFY OFF OFF ON OFF OFF OFF OFF OFF ON processHumidifyStatusEvent State Channel 232 Channel 233 OFF OFF OFF DEHUMIDIFY ON OFF HUMIDIFY ON OFF processHVACStateEvent State Channel 219 C
processHVACStatusEvent State Channel 224 Channel 225 Channel 226 Channel 227 OFF OFF COOL HEAT COOL_2 OFF OFF OFF ON OFF OFF OFF OFF ON OFF OFF OFF OFF ON OFF EMERGENCY_HEAT OFF OFF OFF ON 58 Standard NetLinx API (SNAPI) R 1.8.
InputOutput Device Component Component Name: InputOutput Device Component Interface: IIODeviceComponent IIODeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getIOChannelCount() ?IOCHANNELCOUNT Query for the number of channels on an IO device, responds with IOCHANNELCOUNT getIOChannelDirection(io-chan) ?IOCHANNELDIRECTION- Query for direction of the I/O channel, where is the integer channel number, responds with IOCHANNELDIRECTION getIOChannel
Listener Functions: (Cont.
InputOutput Component Name: InputOutput Interface: IIOComponent IIOComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getIOCount() ?IOCOUNT Query for the number of channels on an IO device, responds with IOCOUNT getIODirection(io-chan) ?IODIRECTION- Query for direction of the I/O channel, where is the integer channel number getIOState(io-chan) ?IOSTATE- Query for state of the I/O channel, where is the integer channel number se
62 Standard NetLinx API (SNAPI) R 1.7.
IO Device Component Name: IO Device Interface: IIODeviceComponent IIODeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getIOChannelCount() ?IOCHANNELCOUNT Query for the number of channels on an IO device, responds with IOCHANNELCOUNT getIOChannelDirection(io-chan) ?IOCHANNELDIRECTION- Query for direction of the I/O channel, where is the integer channel number, responds with IOCHANNELDIRECTION getIOChannelInputSense(io-chan) ?IOCHANNELINPUTSE
64 Standard NetLinx API (SNAPI) R 1.8.
Keypad Component Name: Keypad Interface: IKeypadComponent IKeypadComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addKeypadComponent(index,keypadAddress) KEYPADADD-, Add a keypad address at a given index, where is 1-x and is a keypad address and x is the maximum supported keypad index (see specific module documentation) getKeypadComponentAddress(index) ?KEYPADADDR- Query for the address of the keypad at index , r
Keypad Listener State Charts processButtonStateEvent State Channel RELEASE OFF PUSH ON processButtonStatusEvent State Channel Channel +100 OFF OFF OFF ON ON OFF BLINK ON ON Note: All Keypad commands include an index. This index is used to obtain the keypad component and the function is called on that component. The range for channel '' is 1 to 100; the corresponding range for channel ' + 100' is 101 to 200.
Lamp Component Name: Lamp Interface: ILampComponent ILampComponent Component Functions: Name: cycleLampPower() Channel: Level: Command: 9 Constant: POWER Notes: Momentary Function Channel: Cycle lamp power when channel is activated getCoolDownTime() ?COOLDOWN Query for cool down time, responds with COOLDOWN-
Lamp Listener State Charts processLampPowerEvent State Channel 253 Channel 255 OFF OFF OFF COOL ON OFF ON OFF ON WARM ON 68 ON Standard NetLinx API (SNAPI) R 1.8.
Light Component Name: Light Interface: ILightComponent ILightComponent Component Functions: Name: Channel: Level: Command: addLightComponent(index,lightAddress) LIGHTADD-, Constant: Notes: Add a light at a given index, where is 1 through x and is a light address and x is the maximum supported light index (see specific module documentation) cycleLight(1) LIGHTSTATE-1,TOGGLE Toggle Light Preset 1 cycleLight(10) LIGHTSTATE-10,TOGGLE Toggle Light Preset 10 cycleL
Component Functions: Name: Channel: Level: Command: Constant: Notes: getLightLevel(index) ?LIGHTLEVEL- isLightOn(1) ?LIGHTSTATE-1 Query status of Light Preset 1 isLightOn(10) ?LIGHTSTATE-10 Query status of Light Preset 10 isLightOn(11) ?LIGHTSTATE-11 Query status of Light Preset 11 isLightOn(12) ?LIGHTSTATE-12 Query status of Light Preset 12 isLightOn(13) ?LIGHTSTATE-13 Query status of Light Preset 13 isLightOn(14) ?LIGHTSTATE-14 Query status of Light Preset 14 isLightOn(15)
Component Functions: Name: Channel: Level: Command: setLightOn(index,state) Constant: LIGHTSTATE-, Notes: Set the state of a light for the light at index , where is ON or OFF. This command is relevant for light loads, presets, and scenes.
72 Standard NetLinx API (SNAPI) R 1.8.
Media DB Component Name: Media DB Interface: IMediaDBComponent IMediaDBComponent Component Functions: Name: Channel: Level: Command: closeSearchDB(searchHandle) MEDIADBCLOSESEARCH- Constant: Notes: Close the search associated with search key = deleteRecord(recordID) MEDIADBDELETE- Delete media record with record id of queryDB(mdbss) MEDIADBNEXT- Request next record (count =1) starting with the next record for the media search associated with search key
Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: queryMediaDBProperty(id,key) ?MEDIADBPROP-, Query for one Media Database Property where is the record ID and is the property key to query, responds with MEDIADBPROP-,, where is the record id of the record from which to retrieve the properties, is the property key and is the property value.
Media Device Component Name: Media Device Interface: IMediaDeviceComponent IMediaDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleMediaDeviceRandom() 124 MEDIA_RANDOM Momentary Function Channel: Cycle random when channel is activated cycleMediaDeviceRepeat() 125 MEDIA_REPEAT Momentary Function Channel: Cycle repeat when channel is activated getMediaDeviceSource() ?DECODESOURCE Query for Media Device Source, responds with DECODESOURCE- where
Listener Name: Media Device Listener Interface: IMediaDeviceComponentListener IMediaDeviceComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processMediaDeviceCounterEvent MEDIACOUNTER- Media counter changed, where is a String in the format [-]hh:mm:ss.ff processMediaDevicePropertiesEvent DECODEPROP-, Media property value where is the property key and is the property value. One command is returned for each key.
Media Device Listener State Charts processMediaDeviceRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON OFF OFF RANDOM_ALL OFF ON OFF RANDOM_OFF OFF OFF ON processMediaDeviceRepeatStateEvent State Channel 181 Channel 182 Channel 183 Channel 184 REPEAT_DISC ON REPEAT_TRACK OFF OFF OFF OFF ON OFF OFF REPEAT_ALL OFF OFF ON OFF REPEAT_OFF OFF OFF OFF ON Standard NetLinx API (SNAPI) R 1.8.
78 Standard NetLinx API (SNAPI) R 1.8.
Menu Component Name: Menu Interface: IMenuComponent IMenuComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: moveMenuCursor(DOWN) 46 MENU_DN Momentary Function Channel: Move menu cursor DOWN moveMenuCursor(DOWN_LEFT) 53 MENU_DN_LT Momentary Function Channel: Move menu cursor DOWN_LEFT moveMenuCursor(DOWN_RIGHT) 54 MENU_DN_RT Momentary Function Channel: Move menu cursor DOWN_RIGHT moveMenuCursor(LEFT) 47 MENU_LT Momentary Function Channel: Move menu cursor LEF
Component Functions: (Cont.
Component Functions: (Cont.
Component Functions: (Cont.
Component Functions: (Cont..
84 Standard NetLinx API (SNAPI) R 1.8.
Module Component Name: Module Interface: IModuleComponent IModuleComponent Component Functions: Name: Channel: Level: Command: getDebugState() Constant: ?DEBUG Notes: Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) ?PROPERTY- Query for the value of property , respond with PROPERTY-, getVersion() ?VERS
86 Standard NetLinx API (SNAPI) R 1.8.
Monitor Component Name: Monitor Interface: IMonitorComponent IMonitorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Monitor Listener Interface: IMonitorComponentListener IMonitorComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
88 Standard NetLinx API (SNAPI) R 1.8.
Motor Component Name: Motor Interface: IMotorComponent IMotorComponent Component Functions: Name: cycleMotorPreset() Channel: Level: Command: 187 getMotorPreset() Constant: Notes: MOTOR_PRESET Momentary Function Channel: Cycle Motor preset when channel is activated ?MOTORPRESET Query for Motor preset, responds with MOTORPRESET- setMotorDirection(CLOSE) 5 MOTOR_CLOSE Momentary Function Channel: Set Motor direction to close, causing motor to move in the CLOSE direction setMotorDirecti
Motor Listener State Charts processMotorDirectionEvent State Channel 2 Channel 4 Channel 5 STOP ON OFF OFF OPEN OFF ON OFF OFF ON CLOSE OFF 90 Standard NetLinx API (SNAPI) R 1.8.
Multi Window Component Name: Multi Window Interface: IMultiWindowComponent IMultiWindowComponent Component Functions: Name: cycleMultiWindowPreset() Channel: Level: Command: 136 Constant: Notes: MULTIWIN_PRESET Momentary Function Channel: Cycle multi-window preset when channel is activated getMultiWindowPreset() ?MULTIWINPRESET Query for multi-window preset, responds with MULTIWINPRESET- saveMultiWindowPreset(nPresetNum) MULTIWINPRESETSAVE- Save multi-window Preset where
92 Standard NetLinx API (SNAPI) R 1.8.
Output Stream Component Name: Output Stream Interface: IOutputStreamComponent IOutputStreamComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addOutputStreamSink(cURISink) ENCODESINKADD- Add an Output Stream Sink where is the URL of the sink to be added. getOutputStreamSinks() ?ENCODESINK Query for Output Stream Sinks, responds with multiple ENCODESINK-, one for each output stream sink, where is the URL of the sink/destination.
94 Standard NetLinx API (SNAPI) R 1.8.
Phonebook Component Name: Phonebook Interface: IPhonebookComponent IPhonebookComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: closeSearchDB(searchHandle) PHONEBOOKCLOSESEARCH Close the search associated with search key = deleteRecord(recordID) PHONEBOOKDELETE- Delete phonebook record with index/id of getPhonebookCapacity() ?PHONEBOOKCAPACITY Query for the phonebook capacity.
Listener Name: Phonebook Listener Interface: IPhonebookComponentListener IPhonebookComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processCloseEvent PHONEBOOKCLOSESEARCH The search associated with search key have been closed. No more operations can be performed against this search. processDeleteRecordEvent PHONEBOOKDELETE-, Phonebook record with index/id of was deleted if is 1, otherwise delete failed.
Pool Spa Component Name: Pool Spa Interface: IPoolSpaComponent IPoolSpaComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePoolHeatState() 123 POOL_HEAT Momentary Function Channel: Cycle Pool heat state when channel is activated cycleSpaHeatState() 124 SPA_HEAT Momentary Function Channel: Cycle Spa heat state when channel is activated cycleSpaJets() 125 SPA_JETS Momentary Function Channel: Cycle Spa jets when channel is activated decrementPoolSetpoint() 15
Component Functions: (Cont.
Listener Functions: (Cont.
Pool Spa Listener State Charts processPoolHeatStateEvent State Channel 174 Channel 175 Channel 176 Channel 177 OFF ON OFF OFF OFF HEATER OFF ON OFF OFF SOLAR OFF OFF ON OFF SOLAR_PREFERRED OFF OFF OFF ON processPoolHeatStatusEvent State Channel 187 Channel 188 OFF OFF OFF HEATER ON OFF SOLAR ON OFF processSpaHeatStateEvent State Channel 178 Channel 179 Channel 180 Channel 181 OFF ON OFF HEATER OFF SOLAR OFF SOLAR_PREFERRED OFF OFF OFF ON OFF OFF OFF ON OFF OF
processSpaJetsEvent State Channel 182 Channel 183 Channel 184 Channel 185 OFF ON OFF LOW OFF OFF OFF ON OFF OFF MEDIUM OFF OFF ON OFF HIGH OFF OFF ON OFF Standard NetLinx API (SNAPI) R 1.8.
102 Standard NetLinx API (SNAPI) R 1.8.
Power Device Component Component Name: Power Device Component Interface: IPowerDeviceComponent IPowerDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Power Device Component Listener Interface: IPowerDeviceComponentListener IPowerDeviceComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.7.
104 Standard NetLinx API (SNAPI) R 1.7.
Power Device Component Name: Power Device Interface: IPowerDevice IPowerDevice Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Power Device Listener Interface: IPowerDeviceListener IPowerDeviceListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.7.
106 Standard NetLinx API (SNAPI) R 1.7.
Power Component Name: Power Interface: IPowerComponent IPowerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Momentary Function Channel: Cycle power when channel is activated cyclePower() 9 POWER setPower(OFF) 28 PWR_OFF Momentary Function Channel: Power is turned off when channel is activated setPower(ON) 27 PWR_ON Momentary Function Channel: Power is turned on when channel is activated setPower(ps) 255 POWER_ON Discrete Function Channel: Power is on whil
108 Standard NetLinx API (SNAPI) R 1.8.
Pre Amp Component Name: Pre Amp Interface: IPreAmpComponent IPreAmpComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: adjustBalance(1) 164 BALANCE_UP Ramping Channel: Balance is incremented when channel is activated adjustBalance(-1) 165 BALANCE_DN Ramping Channel: Balance is decremented when channel is activated adjustBass(1) 166 BASS_UP Ramping Channel: Bass is incremented when channel is activated adjustBass(-1) 167 BASS_DN Ramping Channel: Bass is decrem
Listener Functions: (Cont.) Name: processTrebleEvent 110 Channel: Level: Command: 4 Constant: Notes: TREBLE_LVL Treble changed, range is 0-255 Standard NetLinx API (SNAPI) R 1.8.
Pre Amp Surround Sound Processor Component Name: Pre Amp Surround Sound Processor Interface: IPreAmpSurroundSoundProcessorComponent IPreAmpSurroundSoundProcessorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Pre Amp Surround Sound Processor Listener Interface: IPreAmpSurroundSoundProcessorComponentListener IPreAmpSurroundSoundProcessorComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes:
112 Standard NetLinx API (SNAPI) R 1.8.
Receiver Component Name: Receiver Interface: IReceiverComponent IReceiverComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Receiver Listener Interface: IReceiverComponentListener IReceiverComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
114 Standard NetLinx API (SNAPI) R 1.8.
Relay Device Component Component Name: Relay Device Component Interface: IRelayDeviceComponent IRelayDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getRelayChannelCount() ?RELAYCHANNELCOUNT Query for the number of channels on a relay device, responds with RELAYCHANNELCOUNT getRelayChannelState(rly-chan) ?RELAYCHANNELSTATE- Query for the relay channel state, where is the integer channel number, responds with RELAYCHANNELCOUNT setRelayChan
116 Standard NetLinx API (SNAPI) R 1.7.
Relay Device Component Name: Relay Device Interface: IRelayDeviceComponent IRelayDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getRelayChannelCount() ?RELAYCHANNELCOUNT Query for the number of channels on a relay device, responds with RELAYCHANNELCOUNT getRelayChannelState(rly-chan) ?RELAYCHANNELSTATE- Query for the relay channel state, where is the integer channel number, responds with RELAYCHANNELCOUNT setRelayChannelState(rly-chan, r
118 Standard NetLinx API (SNAPI) R 1.8.
Security System Component Name: Security System Interface: ISecuritySystemComponent ISecuritySystemComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getPointState(secPoint) ?SECPOINTSTATE- Query for Point State, responds with SECPOINTSTATE-, where is 1 to the maximum point point as returned by getPointCount() (see specific module documentation) and is BYPASS or ACTIVE getPointStatus(secPoint) ?SECPOINTSTATUS- Query for Poin
Listener Functions: (Cont.) Name: processSecurityStatusEvent 120 Channel: Level: Command: SECSTATUS- Constant: Notes: Security Status changed, where is DISARMED, ARMED_HOME, ARMED, ALARM Standard NetLinx API (SNAPI) R 1.8.
Sensor Component Name: Sensor Interface: ISensorComponent ISensorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Sensor Listener Interface: ISensorComponentListener ISensorComponentListener Listener Functions: Name: Channel: processSensorStateEvent Level: Command: 255 processSensorValueEvent 7 Constant: Notes: SENSOR_FB Feedback Channel: Sensor state changed, sensor is on while channel is on SENSOR_VALUE Value of th
122 Standard NetLinx API (SNAPI) R 1.8.
Settop Box Component Name: Settop Box Interface: ISettopBoxComponent ISettopBoxComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleABSwitch() 42 CABLE_AB Momentary Function Channel: Cycle AB switch when channel is activated setBSwitchOn(state) 212 CABLE_B_ON Discrete Function Channel: AB switch set to B when channel is active Listener Name: Settop Box Listener Interface: ISettopBoxComponentListener ISettopBoxComponentListener Listener Functions: Name: process
124 Standard NetLinx API (SNAPI) R 1.8.
Slide Projector Component Name: Slide Projector Interface: ISlideProjectorComponent ISlideProjectorComponent Component Functions: Name: Channel: Level: Command: getSlide() Constant: ?SLIDE Notes: Query for Slide, responds with SLIDE- where is 1 to x where x is the maximum support slide (see specific module documentation) nextSlide() 4 SLIDE_NEXT Momentary Function Channel: Slide is advanced to the next slide when channel is activated previousSlide() 5 SLIDE_PREV Momentary Func
126 Standard NetLinx API (SNAPI) R 1.8.
Source Select Component Name: Source Select Interface: ISourceSelectComponent ISourceSelectComponent Component Functions: Name: cycleInputSource() Channel: Level: Command: 196 Constant: Notes: SOURCE_CYCLE Momentary Function Channel: Cycle input source when channel is activated getInputCount() ?INPUTCOUNT Query for the number of inputs getInputGroupSelect() ?INPUTGROUPSELECT Query for currently selected input group getInputProperties() ?INPUTPROPERTIES Query for the properties of all input
Component Functions: (Cont.
Switcher Component Name: Switcher Interface: ISwitcherComponent ISwitcherComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getInput(sl,output) ?INPUT-[,]
130 Standard NetLinx API (SNAPI) R 1.8.
Tape Transport Component Name: Tape Transport Interface: ITapeTransportComponent ITapeTransportComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Momentary Function Channel: Cycle search speed when channel is activated cycleSearchSpeed() 119 SEARCH_SPEED ejectTape() 120 EJECT Momentary Function Channel: Tape is ejected when channel is activated resetTapeCounter() 121 RESET_COUNTER Momentary Function Channel: Counter is reset when channel is activated setTapeCoun
Listener Functions: (Cont.
Tape Transport Listener State Charts processTapeTransportEvent State Channel 241 Channel 242 Channel 243 Channel 244 Channel 245 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY ON OFF OFF OFF OFF OFF OFF OFF OFF OFF STOP OFF ON OFF OFF OFF OFF OFF OFF OFF OFF PAUSE OFF OFF ON OFF OFF OFF OFF OFF OFF OFF FF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF REW OFF OFF OFF OFF ON OFF OFF OFF OFF OFF SEARCH_FWD OFF OFF OFF OFF OFF ON OFF OF
134 Standard NetLinx API (SNAPI) R 1.8.
Text Keypad Component Name: Text Keypad Interface: ITextKeypadComponent ITextKeypadComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: clearDisplay() TEXT- setBacklightOn(state) TEXTBACKLIGHT- Clear display. "-" is optional Set BacklightOn where (see specific module documentation) setText(line,column,text) TEXT-,, Set text starting at a given line and column. Characters will be overwritten as needed based on text.
136 Standard NetLinx API (SNAPI) R 1.8.
Tuner Station Component Name: Tuner Station Interface: ITunerStationComponent ITunerStationComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleBand() 40 TUNER_BAND Momentary Function Channel: Cycle tuner band when channel is activated cycleDisplayInfo() 234 TUNER_OSD Momentary Function Channel: Cycle on-screen or front-panel display info when channel is activated cycleStationPresetGroup() 224 TUNER_PRESET_GROU P Momentary Function Channel: Cycle station pres
Component Functions: (Cont.) Name: scanStation(BACKWARD) Channel: Level: Command: 228 Constant: Notes: TUNER_SCAN_REV Momentary Function Channel: Scans for previous station while channel is activate scanStation(FORWARD) 227 TUNER_SCAN_FWD Momentary Function Channel: Scans for next station while channel is activate.
Listener Functions: (Cont.
140 Standard NetLinx API (SNAPI) R 1.8.
TV Component Name: TV Interface: ITVComponent ITVComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: TV Listener Interface: ITVComponentListener ITVComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
142 Standard NetLinx API (SNAPI) R 1.8.
Utility Component Name: Utility Interface: IUtilityComponent IUtilityComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Utility Listener Interface: IUtilityComponentListener IUtilityComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
144 Standard NetLinx API (SNAPI) R 1.8.
VCR Component Name: VCR Interface: IVCRComponent IVCRComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: VCR Listener Interface: IVCRComponentListener IVCRComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
146 Standard NetLinx API (SNAPI) R 1.8.
Video Conferencer Component Name: Video Conferencer Interface: IVideoConferencerComponent IVideoConferencerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePIP() 194 PIP Momentary Function Channel: Cycle PIP when channel is activated cyclePIPPosition() 191 PIP_POS Momentary Function Channel: Cycle PIP positions when channel is activated cyclePrivacy() 145 VCONF_PRIVACY Momentary Function Channel: Cycle privacy when channel is activated setPIPOn(state) 195
148 Standard NetLinx API (SNAPI) R 1.8.
Video Processor Component Name: Video Processor Interface: IVideoProcessorComponent IVideoProcessorComponent Component Functions: Name: cycleVideoProcessorPreset() Channel: Level: Command: 137 Constant: Notes: VPROC_PRESET Momentary Function Channel: Cycle video processor preset when channel is activated getVideoProcessorPreset() ?VPROCPRESET Query for video processor preset, responds with VPROCPRESET- saveVideoProcessorPreset(nPresetNum) VPROCPRESETSAVE- Save video processor
150 Standard NetLinx API (SNAPI) R 1.8.
Video Projector Component Name: Video Projector Interface: IVideoProjectorComponent IVideoProjectorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getProjectorPreset() ?VPROJPRESET Query for projector preset, responds with VPROJPRESET- setProjectorPreset(preset) VPROJPRESET- Recall projector preset where is 1-x and x is the maximum supported preset (see specific module documentation) Listener Name: Video Projector Listener Interface: IVide
152 Standard NetLinx API (SNAPI) R 1.8.
Video Wall Component Name: Video Wall Interface: IVideoWallComponent IVideoWallComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getVideoWallConfiguration() ?VWALLCONFIG Query for video wall configuration, responds with VWALLCONFIG- queryVideoWallConfigurationList() ?VWALLCONFIGLIST Query for the list of available Video Wall Configurations, responds with multiple VWALLCONFIGLIST- commands, one for each valid configuration saveVideoWallConfiguration(s
154 Standard NetLinx API (SNAPI) R 1.8.
Volume Controller Component Name: Volume Controller Interface: IVolumeControllerComponent IVolumeControllerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Listener Name: Volume Controller Listener Interface: IVolumeControllerComponentListener IVolumeControllerComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: Intentionally left blank Standard NetLinx API (SNAPI) R 1.8.
156 Standard NetLinx API (SNAPI) R 1.8.
Volume Component Name: Volume Interface: IVolumeComponent IVolumeComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleVolumeMute() 26 VOL_MUTE Momentary Function Channel: Cycle volume mute when channel is activated cycleVolumePreset() 138 VOL_PRESET Momentary Function Channel: Cycle camera preset when channel is activated getVolumePreset() ?VOLPRESET Query for volume preset, responds with VOLPRESET- saveVolumePreset(preset) VOLPRESETSAVE- Sa
158 Standard NetLinx API (SNAPI) R 1.8.
Weather Component Name: Weather Interface: IWeatherComponent IWeatherComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getChanceOfPrecipitation() ?FORECASTCOP Query for forecast chance of percipitation changes, respons with FORECASTCOP,,etcÖ Value list will contain one forcast chance of percipitation for each forecast day. The first day is always today. Values are in percent.
Listener Name: Weather Listener Interface: IWeatherComponentListener IWeatherComponentListener Listener Functions: Name: Channel: processBarometricPressureEvent Level: Command: 48 Constant: Notes: WEATHER_BAR_LVL Barometric pressure changed, value is in inches Hg (Imperial Scale) or mm Hg/torr (Metric Scale) processBarometricTrendEvent 233 WEATHER_BAR_FALLIN G Feedback Channel: Barometric pressure trend change (see chart below) processBarometricTrendEvent 232 WEATHER_BAR_RISING Feedback Cha
Listener Functions: Name: Channel: processOutdoorTemperatureEvent Level: Command: 34 Constant: Notes: OUTDOOR_TEMP_LVL Outdoor temperature changed, value is in degrees C or F depending on weather scale processRainfallEvent WEATHERRAIN-, Rain fall changed, where is DAY, WEEK, MONTH, YEAR, YTD and is in inches (Imperial Scale) or cm (Metric Scale).
162 Standard NetLinx API (SNAPI) R 1.8.
Window Component Name: Window Interface: IWindowComponent IWindowComponent Component Functions: Name: Channel: Level: Command: addWindowComponent(index,windowAddress) Constant: WINDOWADD-, Notes: Add a window at a given index, where is 1 through x and is a window address and x is the maximum supported window index (see specific module documentation) adjustBrightness(1) 148 BRIGHT_UP adjustBrightness(-1) 149 BRIGHT_DN Momentary Function Channel: Brightness is
Component Functions: Name: Channel: Level: Command: getZOrder() Constant: ?WINDOWZORDER Notes: Get the Z-order.
Listener Name: Window Listener Interface: IWindowComponentListener IWindowComponentListener Listener Functions: Name: Channel: processBrightnessEvent Level: Command: 10 Constant: Notes: BRIGHT_LVL Brightness changed, range is 0-255 processColorEvent 11 COLOR_LVL Color changed, range is 0-255 processContrastEvent 12 CONTRAST_LVL Contrast changed, range is 0-255 processFreezeEvent 214 PIC_FREEZE_FB Feedback Channel: Freeze is on if channel is on processImageEvent IMAGE,,,<
166 Standard NetLinx API (SNAPI) R 1.8.
Standard NetLinx API (SNAPI): Components and Listeners Standard NetLinx API (SNAPI) R 1.8.
AMX reserves the right to alter specifications without notice at any time. ARGENTINA • AUSTRALIA • BELGIUM • BRAZIL • CANADA • CHINA • ENGLAND • FRANCE • GERMANY • GREECE • HONG KONG • INDIA • INDONESIA • ITALY • JAPAN LEBANON • MALAYSIA • MEXICO • NETHERLANDS • NEW ZEALAND • PHILIPPINES • PORTUGAL • RUSSIA • SINGAPORE • SPAIN • SWITZERLAND • THAILAND • TURKEY • USA 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.
