AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS Instruction Manual
  1. Manuals
  2. Brands
  3. AMX Manuals
  4. Software
  5. CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND...
  6. Instruction manual
AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS Instruction Manual

AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS Instruction Manual

Standard netlinx api (snapi) r 1.8.0 components/listeners
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
instruction manual
Standard NetLinx API
(SNAPI) R 1.8.0
Components/Listeners
last revision: 8-29-06
Document ID: 033-004-2993

Advertisement

Table of Contents
loading

Related Manuals for AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS

Summary of Contents for AMX CAFE DUET STANDARD NETLINX API (SNAPI) COMPONENTS AND LISTENERS

  • Page 1 instruction manual Standard NetLinx API (SNAPI) R 1.8.0 Components/Listeners last revision: 8-29-06 Document ID: 033-004-2993...
  • Page 2 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.

  • Page 3: Table Of Contents

    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 ........................
  • Page 4 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 ........................
  • Page 5 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 ......................
  • Page 6 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 7: Interfacing With Standard Netlinx Api (Snapi)

    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.
  • Page 8 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.
  • Page 9 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.

  • Page 10: Programming

    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:...
  • Page 11 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:...

  • Page 12: Channel And Level Ranges

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

  • Page 13: Commands And Escape Characters

    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: Hello Brown Eyed Girl...
  • Page 14 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...

  • Page 15: Amplifier

    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.0...
  • Page 16 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 17: Audio Conferencer

    Audio Conferencer Component Name: Audio Conferencer Interface: IAudioConferencerComponent IAudioConferencerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePrivacy() ACONF_PRIVACY Momentary Function Channel: Cycle privacy when channel is activated setPrivacyOn(state) ACONF_PRIVACY_ON Discrete Function Channel: Privacy is on while channel is active train() ACONF_TRAIN Momentary Function Channel: Train is executed when the channel is activated...
  • Page 18 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 19: Audio Mixer

    Audio Mixer Component Name: Audio Mixer Interface: IAudioMixerComponent IAudioMixerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getAudioMixerCross- ?XPOINT-<input>,<output> Query for Audio Mixer Crosspoint, responds with XPOINT-<value>,<input>,<output> point(input,output) where <value> is 0 to 255, <input> is 1 to the maximum supported input and <output> is the maximum supported output (see specific module documentation) getAudioMixerPreset() ?MIXERPRESET...
  • Page 20 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 21: Audio Processor

    Audio Processor Component Name: Audio Processor Interface: IAudioProcessorComponent IAudioProcessorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addAudioProcessorCom- AUDIOPROCADD- Add a Audio Processor object at a given index, where <index> is 1 through x and ponent(index,audioPro- <index>,<address> <address> is the object address and x is the maximum supported index (see specific cessorAddress) module documentation) adjustAudioProcessor-...
  • Page 22 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: saveAudioProcessorPre- AUDIOPROCPRESETSAVE-<pre- Save Audio Processor Preset where <preset> is 1 to x and x is the maximum supported set(preset) set> preset (see specific module documentation) setAudioProcessorCros- XPOINT-<value>,<input>,<out- Set Audio Processor crosspoint for <input> to one or more <output>s where <value> is spoint(input,out- put>[,<output>,<output>Ö] 0 to 255.

  • Page 23: Audio Tape

    Audio Tape Component Name: Audio Tape Interface: IAudioTapeComponent IAudioTapeComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAudioTapeRecord- CASS_RECORD_MUTE Momentary Function Channel: Cycle record mute when channel is activated Mute() cycleAudioTapeSide() CASS_TAPE_SIDE Momentary Function Channel: Cycle tape side when channel is activated reversePlay() CASS_REVERSE_PLAY Momentary Function Channel: Reverse direction of play (but not the side).
  • Page 24 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 25: Audio Tuner Device

    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.0...
  • Page 26 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 27: Camera

    Camera Component Name: Camera Interface: ICameraComponent ICameraComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAutoFocus() AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated cycleCameraPreset() CAM_PRESET Momentary Function Channel: Cycle camera preset when channel is activated getCameraComponent-...
  • Page 28 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: setTiltRamp(DOWN) TILT_DN Ramping Channel: Tilt is ramped down while channel is active setTiltRamp(UP) TILT_UP Ramping Channel: Tilt is ramped up while channel is active setTiltSpeed(speed) TILT_SPEED_LVL Set tilt speed, range is 0-255 (0=slow) setZoom(zoom) ZOOM_LVL Set zoom position, range is 0-255 (0=out/Wide)
  • Page 29 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processIrisSpeedEvent IRIS_SPEED_LVL Iris speed changed, range is 0-255 (0=slow) processPanEvent PAN_LVL Pan changed, range is 0-255 (0=left) processPanRampEvent PAN_LT_FB Feedback Channel: Pan is ramping left while channel is on processPanRampEvent PAN_RT_FB Feedback Channel: Pan is ramping right up while channel is on processPanSpeedEvent PAN_SPEED_LVL...
  • Page 30 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 31: Dialer

    Dialer Component Name: Dialer Interface: IDialerComponent IDialerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAudibleRing() DIAL_AUDIBLE_RING Momentary Function Channel: Cycle audible ring when channel is activated cycleAutoAnswer() DIAL_AUTO_ANSWER Momentary Function Channel: Cycle auto answer when channel is activated cycleOffHook() DIAL_OFF_HOOK Momentary Function Channel: Cycle hook state when channel is activated dial(index)
  • Page 32 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processDialerStatusEv- DIALERSTATUS-DIALING Dialer status changed, dialer is dialing processDialerStatusEv- DIALERSTATUS-DISCONNECTED Dialer status changed, dialer is disconnected/idel processDialerStatusEv- DIALERSTATUS-FAULT Dialer status changed, dialer encounter a fault during dialing/negotiating processDialerStatusEv- DIALERSTATUS-NEGOTIATING Dialer status changed, dialer is negotiating processDialerStatusEv- DIALERSTATUS-RINGING Dialer status changed, number being dialed is ringing...

  • Page 33: Digital Media Decoder

    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.0...
  • Page 34 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 35: Digital Media Encoder

    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.0...
  • Page 36 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 37: Digital Media Server

    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.0...
  • Page 38 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 39: Digital Satellite System

    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 (SNAPI) R 1.8.0...
  • Page 40 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 41: Digital Video Recorder

    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.0...
  • Page 42 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 43: Disc Device

    Disc Device Component Name: Disc Device Interface: IDiscDeviceComponent IDiscDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleDiscTray() DISC_TRAY Momentary Function Channel: Open or Close the disc tray when the channel is acti- vated cycleRandom() DISC_RANDOM Momentary Function Channel: Cycle random when channel is activated cycleRepeat() DISC_REPEAT Momentary Function Channel: Cycle repeat when channel is activated...
  • Page 44 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: setRepeat- DISC_REPEAT_ALL_ON Momentary Function Channel: Repeat-all is on while channel is active State(REPEAT_ALL) setRepeat- DISC_REPEAT_DISC_ON Momentary Function Channel: Repeat-disc is on while channel is active State(REPEAT_DISC) setRepeat- DISC_REPEAT_OFF_ON Momentary Function Channel: Repeat-off is on while channel is active State(REPEAT_OFF) setRepeat- DISC_REPEAT_TRACK_...
  • Page 45 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processTitleInfoEvent TITLEINFO-<num>,<duration>,<# of Title info changed, where <num> is title number, <duration> is a title duration String in tracks>,<discNumber> the format [-]hh:mm:ss.ff, <# of tracks> is the number of tracks inthis title and <disc- Number>...
  • Page 46 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 47: Disc Transport

    Disc Transport Component Name: Disc Transport Interface: IDiscTransportComponent IDiscTransportComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleScanSpeed() SCAN_SPEED Momentary Function Channel: Cycles the scan speed when the channel is activated getTrackInfo() ?TRACKINFO Query for the track info, responds with TRACKINFO-<num>,<duration>,<discNumber>, where <duration>...
  • Page 48 Listener Name: Disc Transport Listener Interface: IDiscTransportComponentListener IDiscTransportComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processDiscTrans- PAUSE_FB Feedback Channel: Transport state change (see chart below) portEvent processDiscTrans- PLAY_FB Feedback Channel: Transport state change (see chart below) portEvent processDiscTrans- RECORD_FB Feedback Channel: Transport state change (see chart below) portEvent processDiscTrans-...
  • Page 49 Disc Transport Listener State Charts processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY STOP PAUSE SCAN_FWD SCAN_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV Standard NetLinx API (SNAPI) R 1.8.0...
  • Page 50 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 51: Display

    Display Component Name: Display Interface: IDisplayComponent IDisplayComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: adjustBrightness(1) BRIGHT_UP Momentary Function Channel: Brightness is incremented when channel is activated adjustBrightness(-1) BRIGHT_DN Momentary Function Channel: Brightness is decremented when channel is activated adjustColor(1) COLOR_UP Momentary Function Channel: Color is incremented when channel is activated adjustColor(-1)
  • Page 52 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: setAspectRatioSe- ASPECTRATIOSELECT-<index> Set Aspect Ratio lect(index) setBrightness(level) BRIGHT_LVL Set brightness level, range is 0-255 setColor(level) COLOR_LVL Set color level, range is 0-255 setContrast(level) CONTRAST_LVL Set contrast level, range is 0-255 setFreezeOn(state) PIC_FREEZE_ON Discrete Function Channel: Freeze is on while channel is active setPictureMuteOn(state)
  • Page 53 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processPictureMu- PIC_MUTE_FB Feedback Channel: Picture is muted if channel is on teEvent processPIPEvent PIP_FB Feedback Channel: PIP is on if channel is on processSharpnessEvent SHARP_LVL Sharpness changed, range is 0-255 processTintEvent TINT_LVL Tint changed, range is 0-255 processVideoTypeEvent...
  • Page 54 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 55: Document Camera

    Document Camera Component Name: Document Camera Interface: IDocumentCameraComponent IDocumentCameraComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleAutoFocus() AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated cycleAutoIris() AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated cycleLight() DOCCAM_LIGHT Momentary Function Channel: Cycle lights when channel is activated...
  • Page 56 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processFocusEvent FOCUS_LVL Focus changed, range is 0-255 (0=near) processFocusRampE- FOCUS_FAR_FB Feedback Channel: Focus is ramping far while channel is on vent processFocusRampE- FOCUS_NEAR_FB Feedback Channel: Focus is ramping near while channel is on vent processFocusSpeedE- FOCUS_SPEED_LVL...

  • Page 57: Gain

    Gain Component Name: Gain Interface: IGainComponent IGainComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleGainMute() GAIN_MUTE Momentary Function Channel: Cycle gain mute when channel is activated setGain(level) GAIN_LVL Set gain, range is 0-255 setGainMuteOn(state) GAIN_MUTE_ON Discrete Function Channel: Gain mute is on while channel is active setGainRamp(DOWN) GAIN_DN Ramping Channel: Gain is ramped down while channel is active...
  • Page 58 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 59: Hvac

    HVAC Component Name: HVAC Interface: IHVACComponent IHVACComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addHVACCompo- HVACADD-<index>,<hvacAddress> Add a thermostat at a given index, where <index> is 1-x and <address> is a thermostat nent(index,hvacAddress) address and x is the maximum supported thermostat index (see specific module docu- mentation) cycleFanState() HVAC_FAN...
  • Page 60 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: setDehumidifySet- HVAC_DEHUMIDIFY_LVL Set the dehumidify setpoint, value is in percent point(setpoint) setFanState(AUTO) HVAC_FAN_AUTO Momentary Function Channel: Fan state is auto while channel is active setFanState(ON) HVAC_FAN_ON Momentary Function Channel: Fan state is on while channel is active setHeatSetpoint(set- HVAC_HEAT_LVL Set the heat setpoint, value is in degrees C or F depending on temperature scale...
  • Page 61 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processFanStateEvent HVAC_FAN_ON_FB Feedback Channel: Fan state is on while channel is on processFanStatusEvent HVAC_FAN_STATUS_FB Feedback Channel: Fan status is on while channel is on processHeatSet- HVAC_HEAT_LVL Heat setpoint changed, value is in degrees C or F depending on temperature scale pointEvent processHoldEvent HVAC_HOLD_FB...
  • Page 62 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processLockEvent HVAC_LOCK_FB Feedback Channel: Thermostat is locked while channel is on processOutdoorHumidi- OUTDOOR_HUMID_LVL Outdoor humidity changed, value is in percent tyEvent processOutdoorTemper- OUTDOOR_TEMP_LVL Outdoor temperature changed, value is in degrees C or F depending on temperature atureEvent scale processTemperatureS-...
  • Page 63 HVAC Listener State Charts processFanStateEvent State Channel 214 Channel 215 AUTO OFF processFanStatusEvent State Channel 216 processHumidifyStateEvent State Channel 228 Channel 229 Channel 230 Channel 231 AUTO DEHUMIDIFY OFF HUMIDIFY processHumidifyStatusEvent State Channel 232 Channel 233 DEHUMIDIFY ON HUMIDIFY processHVACStateEvent State Channel 219 Channel 220 Channel 221 Channel 222 Channel 223 AUTO...
  • Page 64 processHVACStatusEvent State Channel 224 Channel 225 Channel 226 Channel 227 COOL HEAT COOL_2 EMERGENCY_HEAT OFF Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 65: Inputoutput Device Component

    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 getIOChannelDirec- ?IOCHANNELDIRECTION-<io- Query for direction of the I/O channel, where <io-chan> is the integer channel number, tion(io-chan) chan>...
  • Page 66 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processIOChannelDirec- IOCHANNELDIRECTION-<io- Response to ?IOCHANNELDIRECTION, where <io-chan> is the integer channel num- tionEvent chan>,INPUT processIOChannelDirec- IOCHANNELDIRECTION-<io- Response to ?IOCHANNELDIRECTION, where <io-chan> is the integer channel num- tionEvent chan>,<io-dir> ber and <io-dir> is INPUT or OUTPUT processIOChannelDirec- IOCHANNELDIRECTION-<io- Response to ?IOCHANNELDIRECTION, where <io-chan>...

  • Page 67: Inputoutput

    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-<io-chan> Query for direction of the I/O channel, where <io-chan> is the integer channel number getIOState(io-chan) ?IOSTATE-<io-chan>...
  • Page 68 Standard NetLinx API (SNAPI) R 1.7.0...

  • Page 69: Io Device

    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 getIOChannelDirec- ?IOCHANNELDIRECTION-<io- Query for direction of the I/O channel, where <io-chan> is the integer channel number, tion(io-chan) chan>...
  • Page 70 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 71: Keypad

    Keypad Component Name: Keypad Interface: IKeypadComponent IKeypadComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addKeypadCompo- KEYPADADD-<index>,<key- Add a keypad address at a given index, where <index> is 1-x and <keypadaddr> is a nent(index,keypadAd- padaddr> keypad address and x is the maximum supported keypad index (see specific module dress) documentation) getKeypadComponen-...
  • Page 72 Keypad Listener State Charts processButtonStateEvent State Channel <btn> RELEASE PUSH processButtonStatusEvent State Channel <btn> Channel <btn>+100 BLINK 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 '<btn>' is 1 to 100;...

  • Page 73: Lamp

    Lamp Component Name: Lamp Interface: ILampComponent ILampComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleLampPower() POWER Momentary Function Channel: Cycle lamp power when channel is activated getCoolDownTime() ?COOLDOWN Query for cool down time, responds with COOLDOWN-<time> where <time> is in sec- onds getLampTime() ?LAMPTIME...
  • Page 74 Lamp Listener State Charts processLampPowerEvent State Channel 253 Channel 255 COOL WARM ON Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 75: Light

    Light Component Name: Light Interface: ILightComponent ILightComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addLightCompo- LIGHTADD-<index>,<address> Add a light at a given index, where <index> is 1 through x and <address> is a light nent(index,lightAddress) address and x is the maximum supported light index (see specific module documenta- tion) cycleLight(1) LIGHTSTATE-1,TOGGLE...
  • Page 76 Component Functions: Name: Channel: Level: Command: Constant: Notes: getLightLevel(index) ?LIGHTLEVEL-<index> Query for the level of a light for the light at index <index>, responds with LIGHTLEVEL- <index>,<level> where <level> is 0-255. This command is relevant for light loads only. isLightOn(1) ?LIGHTSTATE-1 Query status of Light Preset 1 isLightOn(10)
  • Page 77 Component Functions: Name: Channel: Level: Command: Constant: Notes: setLightOn(index,state) LIGHTSTATE-<index>,<state> Set the state of a light for the light at index <index>, where <state> is ON or OFF. This command is relevant for light loads, presets, and scenes. Listener Name: Light Listener Interface: ILightComponentListener ILightComponentListener Listener Functions:...
  • Page 78 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 79: Media Db

    Media DB Component Name: Media DB Interface: IMediaDBComponent IMediaDBComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: closeSearchDB(search- MEDIADBCLOSESEARCH-<key> Close the search associated with search key = <key> Handle) deleteRecord(recordID) MEDIADBDELETE-<id> Delete media record with record id of <id> queryDB(mdbss) MEDIADBNEXT-<key>...
  • Page 80 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: queryMediaDBProp- ?MEDIADBPROP-<id>,<key> Query for one Media Database Property where <id> is the record ID and <key> is the erty(id,key) property key to query, responds with MEDIADBPROP-<id>,<key>,<value> where <id> is the record id of the record from which to retrieve the properties, <key> is the property key and <value>...

  • Page 81: Media Device

    Media Device Component Name: Media Device Interface: IMediaDeviceComponent IMediaDeviceComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleMediaDeviceRan- MEDIA_RANDOM Momentary Function Channel: Cycle random when channel is activated dom() cycleMediaDeviceRe- MEDIA_REPEAT Momentary Function Channel: Cycle repeat when channel is activated peat() getMediaDeviceSource() ?DECODESOURCE...
  • Page 82 Listener Name: Media Device Listener Interface: IMediaDeviceComponentListener IMediaDeviceComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processMediaDevice- MEDIACOUNTER-<counter> Media counter changed, where <counter> is a String in the format [-]hh:mm:ss.ff CounterEvent processMediaDevicePro- DECODEPROP-<key>,<value> Media property value where <key> is the property key and <value> is the property pertiesEvent value.
  • Page 83 Media Device Listener State Charts processMediaDeviceRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON RANDOM_ALL RANDOM_OFF processMediaDeviceRepeatStateEvent State Channel 181 Channel 182 Channel 183 Channel 184 REPEAT_DISC REPEAT_TRACK OFF REPEAT_ALL REPEAT_OFF Standard NetLinx API (SNAPI) R 1.8.0...
  • Page 84 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 85: Menu

    Menu Component Name: Menu Interface: IMenuComponent IMenuComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: moveMenuCur- MENU_DN Momentary Function Channel: Move menu cursor DOWN sor(DOWN) moveMenuCur- MENU_DN_LT Momentary Function Channel: Move menu cursor DOWN_LEFT sor(DOWN_LEFT) moveMenuCur- MENU_DN_RT Momentary Function Channel: Move menu cursor DOWN_RIGHT sor(DOWN_RIGHT) moveMenuCursor(LEFT) MENU_LT...
  • Page 86 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: pressMenuBut- MENU_CLEAR Momentary Function Channel: Press menu button CLEAR ton(CLEAR) pressMenuBut- MENU_COMMA Momentary Function Channel: Press menu button COMMA ton(COMMA) pressMenuButton(CON- MENU_CONFERENCE Momentary Function Channel: Press menu button CONFERENCE FERENCE) pressMenuButton(CON- MENU_CONTINUE Momentary Function Channel: Press menu button CONTINUE TINUE)
  • Page 87 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: pressMenuBut- MENU_ENTER Momentary Function Channel: Press menu button ENTER ton(ENTER) pressMenuButton(EXIT) MENU_EXIT Momentary Function Channel: Press menu button EXIT pressMenuButton(F) ALPHA-F Press menu button F pressMenuBut- MENU_FAVORITES Momentary Function Channel: Press menu button FAVORITES ton(FAVORITES) pressMenuBut- MENU_FLASH...
  • Page 88 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: pressMenuBut- MENU_PAGE_DN Momentary Function Channel: Press menu button PAGE_DOWN ton(PAGE_DOWN) pressMenuBut- MENU_PAGE_UP Momentary Function Channel: Press menu button PAGE_UP ton(PAGE_UP) pressMenuBut- MENU_PLUS_10 Momentary Function Channel: Press menu button PLUS_10 ton(PLUS_10) pressMenuBut- MENU_PLUS_100 Momentary Function Channel: Press menu button PLUS_100 ton(PLUS_100)
  • Page 89 Component Functions: (Cont..) Name: Channel: Level: Command: Constant: Notes: pressMenuButton(T) ALPHA-T Press menu button T pressMenuBut- MENU_THUMBS_DN Momentary Function Channel: Press menu button THUMBS_DOWN ton(THUMBS_DOWN) pressMenuBut- MENU_THUMBS_UP Momentary Function Channel: Press menu button THUMBS_UP ton(THUMBS_UP) pressMenuBut- MENU_TITLE Momentary Function Channel: Press menu button TITLE ton(TITLE) pressMenuBut- MENU_TOP_MENU...
  • Page 90 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 91: Module

    Module Component Name: Module Interface: IModuleComponent IModuleComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getDebugState() ?DEBUG Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() ?FWVERSION Query for the device firmware version, responds with FWVERSION-<version> getProperty(key) ?PROPERTY-<key>...
  • Page 92 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 93: Monitor

    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.0...
  • Page 94 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 95: Motor

    Motor Component Name: Motor Interface: IMotorComponent IMotorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleMotorPreset() MOTOR_PRESET Momentary Function Channel: Cycle Motor preset when channel is activated getMotorPreset() ?MOTORPRESET Query for Motor preset, responds with MOTORPRESET-<preset> setMotorDirec- MOTOR_CLOSE Momentary Function Channel: Set Motor direction to close, causing motor to move in tion(CLOSE) the CLOSE direction setMotorDirec-...
  • Page 96 Motor Listener State Charts processMotorDirectionEvent State Channel 2 Channel 4 Channel 5 STOP OPEN CLOSE OFF Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 97: Multi Window

    Multi Window Component Name: Multi Window Interface: IMultiWindowComponent IMultiWindowComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleMultiWindowPre- MULTIWIN_PRESET Momentary Function Channel: Cycle multi-window preset when channel is activated set() getMultiWindowPreset() ?MULTIWINPRESET Query for multi-window preset, responds with MULTIWINPRESET-<preset> saveMultiWindowPre- MULTIWINPRESETSAVE-<preset>...
  • Page 98 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 99: Output Stream

    Output Stream Component Name: Output Stream Interface: IOutputStreamComponent IOutputStreamComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addOutputStream- ENCODESINKADD-<url> Add an Output Stream Sink where <url> is the URL of the sink to be added. Sink(cURISink) getOutputStreamSinks() ?ENCODESINK Query for Output Stream Sinks, responds with multiple ENCODESINK-<url>, one for each output stream sink, where <url>...
  • Page 100 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 101: Phonebook

    Phonebook Component Name: Phonebook Interface: IPhonebookComponent IPhonebookComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: closeSearchDB(search- PHONEBOOKCLOSESEARCH- Close the search associated with search key = <key> Handle) <key> deleteRecord(recordID) PHONEBOOKDELETE-<id> Delete phonebook record with index/id of <id> getPhonebookCapacity() ?PHONEBOOKCAPACITY 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) queryDB(si)
  • Page 102 Listener Name: Phonebook Listener Interface: IPhonebookComponentListener IPhonebookComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processCloseEvent PHONEBOOKCLOSESEARCH- The search associated with search key <key> have been closed. No more operations <key> can be performed against this search. processDeleteRecordE- PHONEBOOKDELETE-<id>,<suc- Phonebook record with index/id of <id> was deleted if <success> is 1, otherwise delete vent cess>...

  • Page 103: Pool Spa

    Pool Spa Component Name: Pool Spa Interface: IPoolSpaComponent IPoolSpaComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePoolHeatState() POOL_HEAT Momentary Function Channel: Cycle Pool heat state when channel is activated cycleSpaHeatState() SPA_HEAT Momentary Function Channel: Cycle Spa heat state when channel is activated cycleSpaJets() SPA_JETS Momentary Function Channel: Cycle Spa jets when channel is activated...
  • Page 104 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: setSpaHeat- SPA_SOLAR Momentary Function Channel: Set Spa heat state to solar State(SOLAR) setSpaHeat- SPA_SOLAR_PREF Momentary Function Channel: Set Spa heat state to solar preferred State(SOLAR_PREFER RED) setSpaJets(HIGH) SPA_JETS_HI Momentary Function Channel: Set Spa jets to high setSpaJets(LOW) SPA_JETS_LO Momentary Function Channel: Set Spa jets to low...
  • Page 105 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processPoolSpaAuxOn- POOLAUX-<aux number>,<state> Pool/Spa Aux state changed where <aux number> is the number of the aux relay 1 to x Event where x is the maximum supported aux relay and <state> is 1 (on) or 0 (off) (see spe- cific module documentation) processPoolSpaOut- OUTDOOR_TEMP_LVL...
  • Page 106 Pool Spa Listener State Charts processPoolHeatStateEvent State Channel 174 Channel 175 Channel 176 Channel 177 HEATER SOLAR SOLAR_PREFERRED OFF processPoolHeatStatusEvent State Channel 187 Channel 188 HEATER ON SOLAR processSpaHeatStateEvent State Channel 178 Channel 179 Channel 180 Channel 181 HEATER SOLAR SOLAR_PREFERRED OFF processSpaHeatStatusEvent State...
  • Page 107 processSpaJetsEvent State Channel 182 Channel 183 Channel 184 Channel 185 MEDIUM OFF HIGH Standard NetLinx API (SNAPI) R 1.8.0...
  • Page 108 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 109: Power Device Component

    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.0...
  • Page 110 Standard NetLinx API (SNAPI) R 1.7.0...

  • Page 111: Power Device

    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.0...
  • Page 112 Standard NetLinx API (SNAPI) R 1.7.0...

  • Page 113: Power

    Power Component Name: Power Interface: IPowerComponent IPowerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePower() POWER Momentary Function Channel: Cycle power when channel is activated setPower(OFF) PWR_OFF Momentary Function Channel: Power is turned off when channel is activated setPower(ON) PWR_ON Momentary Function Channel: Power is turned on when channel is activated setPower(ps)
  • Page 114 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 115: Pre Amp

    Pre Amp Component Name: Pre Amp Interface: IPreAmpComponent IPreAmpComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: adjustBalance(1) BALANCE_UP Ramping Channel: Balance is incremented when channel is activated adjustBalance(-1) BALANCE_DN Ramping Channel: Balance is decremented when channel is activated adjustBass(1) BASS_UP Ramping Channel: Bass is incremented when channel is activated adjustBass(-1)
  • Page 116 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processTrebleEvent TREBLE_LVL Treble changed, range is 0-255 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 117: Pre Amp Surround Sound Processor

    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:...
  • Page 118 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 119: Receiver

    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.0...
  • Page 120 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 121: Relay Device Component

    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 RELAYCHANNEL- COUNT getRelayChannel- ?RELAYCHANNELSTATE-<rly- Query for the relay channel state, where <rly-chan> is the integer channel number, State(rly-chan) chan>...
  • Page 122 Standard NetLinx API (SNAPI) R 1.7.0...

  • Page 123: Relay Device

    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 RELAYCHANNEL- COUNT getRelayChannel- ?RELAYCHANNELSTATE-<rly- Query for the relay channel state, where <rly-chan> is the integer channel number, State(rly-chan) chan>...
  • Page 124 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 125: Security System

    Security System Component Name: Security System Interface: ISecuritySystemComponent ISecuritySystemComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getPointState(secPoint) ?SECPOINTSTATE-<point> Query for Point State, responds with SECPOINTSTATE-<point>,<state> where <point> is 1 to the maximum point point as returned by getPointCount() (see specific module documentation) and <state>...
  • Page 126 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processSecuritySta- SECSTATUS-<status> Security Status changed, where <status> is DISARMED, ARMED_HOME, ARMED, tusEvent ALARM Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 127: Sensor

    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: Level: Command: Constant: Notes: processSen- SENSOR_FB Feedback Channel: Sensor state changed, sensor is on while channel is on sorStateEvent processSensorVal- SENSOR_VALUE...
  • Page 128 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 129: Settop Box

    Settop Box Component Name: Settop Box Interface: ISettopBoxComponent ISettopBoxComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleABSwitch() CABLE_AB Momentary Function Channel: Cycle AB switch when channel is activated setBSwitchOn(state) CABLE_B_ON Discrete Function Channel: AB switch set to B when channel is active Listener Name: Settop Box Listener Interface: ISettopBoxComponentListener...
  • Page 130 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 131: Slide Projector

    Slide Projector Component Name: Slide Projector Interface: ISlideProjectorComponent ISlideProjectorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getSlide() ?SLIDE Query for Slide, responds with SLIDE-<slide> where <slide> is 1 to x where x is the maximum support slide (see specific module documentation) nextSlide() SLIDE_NEXT Momentary Function Channel: Slide is advanced to the next slide when channel is acti-...
  • Page 132 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 133: Source Select

    Source Select Component Name: Source Select Interface: ISourceSelectComponent ISourceSelectComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleInputSource() 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 inputs...
  • Page 134 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: setInput- SOURCE_VIDEO3 Momentary Function Channel: Selects input VIDEO,3 when channel is activated Source(VIDEO,3) Listener Name: Source Select Listener Interface: ISourceSelectComponentListener ISourceSelectComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processInputCountEvent INPUTCOUNT-<count> Response to ?INPUTCOUNT, where <count>...

  • Page 135: Switcher

    Switcher Component Name: Switcher Interface: ISwitcherComponent ISwitcherComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getInput(sl,output) ?INPUT-[<sl>,]<output> Query for the input connected to an output, respond with SWITCH-L<sl>I<input>O<out- put> where <sl> is ALL, VIDEO, or AUDIO and <input> is 0 if there is no connection.. If <sl>...
  • Page 136 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 137: Tape Transport

    Tape Transport Component Name: Tape Transport Interface: ITapeTransportComponent ITapeTransportComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleSearchSpeed() SEARCH_SPEED Momentary Function Channel: Cycle search speed when channel is activated ejectTape() EJECT Momentary Function Channel: Tape is ejected when channel is activated resetTapeCounter() RESET_COUNTER Momentary Function Channel: Counter is reset when channel is activated...
  • Page 138 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processTapeRecord- RECORD_LOCK_FB Feedback Channel: Tape is record locked while channel is on LockedEvent processTapeTrans- FFWD_FB Feedback Channel: Transport state change (see chart below) portEvent processTapeTrans- PAUSE_FB Feedback Channel: Transport state change (see chart below) portEvent processTapeTrans- PLAY_FB...
  • Page 139 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 STOP PAUSE SEARCH_FWD SEARCH_REV RECORD RECORD_PAUSE OFF SLOW_FWD SLOW_REV Standard NetLinx API (SNAPI) R 1.8.0...
  • Page 140 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 141: Text Keypad

    Text Keypad Component Name: Text Keypad Interface: ITextKeypadComponent ITextKeypadComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: clearDisplay() TEXT- Clear display. "-" is optional setBacklightOn(state) TEXTBACKLIGHT-<state> Set BacklightOn where (see specific module documentation) setText(line,column,text) TEXT-<line>,<column>,<text> Set text starting at a given line and column. Characters will be overwritten as needed based on text.
  • Page 142 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 143: Tuner Station

    Tuner Station Component Name: Tuner Station Interface: ITunerStationComponent ITunerStationComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleBand() TUNER_BAND Momentary Function Channel: Cycle tuner band when channel is activated cycleDisplayInfo() TUNER_OSD Momentary Function Channel: Cycle on-screen or front-panel display info when chan- nel is activated cycleStationPreset- TUNER_PRESET_GROU...
  • Page 144 Component Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: scanStation(BACK- TUNER_SCAN_REV Momentary Function Channel: Scans for previous station while channel is activate WARD) scanStation(FORWARD) TUNER_SCAN_FWD Momentary Function Channel: Scans for next station while channel is activate. seekStation(BACK- TUNER_SEEK_REV Momentary Function Channel: Seeks for previous station while channel is activate WARD) seekStation(FORWARD) TUNER_SEEK_FWD...
  • Page 145 Listener Functions: (Cont.) Name: Channel: Level: Command: Constant: Notes: processTunerBandProp- TUNERBANDPROPERTY- Response to ?TUNERBANDPROPERTY ertyEvent <index>,<displayName>,<tuner- Band> processTunerCompo- TUNERCOMPONENTCOUNT Response to ?TUNERCOUNT, where <count> is the integer number of tuner compo- nentCountEvent nents processTunerCompo- TUNERCOMPONENTPROPER- Response to ?TUNERPROPERTIES nentPropertiesEvent TIES-<index>,<dis- playName>,<value>[;- <index>,<displayName>,<value>] processTunerCompo-...
  • Page 146 Standard NetLinx API (SNAPI) R 1.8.0...
  • Page 147 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.0...
  • Page 148 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 149: Utility

    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.0...
  • Page 150 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 151: 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.0...
  • Page 152 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 153: Video Conferencer

    Video Conferencer Component Name: Video Conferencer Interface: IVideoConferencerComponent IVideoConferencerComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cyclePIP() Momentary Function Channel: Cycle PIP when channel is activated cyclePIPPosition() PIP_POS Momentary Function Channel: Cycle PIP positions when channel is activated cyclePrivacy() VCONF_PRIVACY Momentary Function Channel: Cycle privacy when channel is activated setPIPOn(state)
  • Page 154 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 155: Video Processor

    Video Processor Component Name: Video Processor Interface: IVideoProcessorComponent IVideoProcessorComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleVideoProcessor- VPROC_PRESET Momentary Function Channel: Cycle video processor preset when channel is activated Preset() getVideoProcessorPre- ?VPROCPRESET Query for video processor preset, responds with VPROCPRESET-<preset> set() saveVideoProcessorPre- VPROCPRESETSAVE-<preset>...
  • Page 156 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 157: Video Projector

    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-<preset> setProjectorPreset(pre- VPROJPRESET-<preset> Recall projector preset where <preset> is 1-x and x is the maximum supported preset set) (see specific module documentation) Listener...
  • Page 158 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 159: Video Wall

    Video Wall Component Name: Video Wall Interface: IVideoWallComponent IVideoWallComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getVideoWallConfigura- ?VWALLCONFIG Query for video wall configuration, responds with VWALLCONFIG-<config> tion() queryVideoWallConfigu- ?VWALLCONFIGLIST Query for the list of available Video Wall Configurations, responds with multiple rationList() VWALLCONFIGLIST-<config>...
  • Page 160 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 161: Volume Controller

    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.0...
  • Page 162 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 163: Volume

    Volume Component Name: Volume Interface: IVolumeComponent IVolumeComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: cycleVolumeMute() VOL_MUTE Momentary Function Channel: Cycle volume mute when channel is activated cycleVolumePreset() VOL_PRESET Momentary Function Channel: Cycle camera preset when channel is activated getVolumePreset() ?VOLPRESET Query for volume preset, responds with VOLPRESET-<preset>...
  • Page 164 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 165: Weather

    Weather Component Name: Weather Interface: IWeatherComponent IWeatherComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: getChanceOfPrecipita- ?FORECASTCOP Query for forecast chance of percipitation changes, respons with FORECASTCOP- tion() <day 1>,<day 2>,etcÖ Value list will contain one forcast chance of percipitation for each forecast day.
  • Page 166 Listener Name: Weather Listener Interface: IWeatherComponentListener IWeatherComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processBarometricPres- WEATHER_BAR_LVL Barometric pressure changed, value is in inches Hg (Imperial Scale) or mm Hg/torr sureEvent (Metric Scale) processBarometric- WEATHER_BAR_FALLIN Feedback Channel: Barometric pressure trend change (see chart below) TrendEvent processBarometric- WEATHER_BAR_RISING...
  • Page 167 Listener Functions: Name: Channel: Level: Command: Constant: Notes: processOutdoorTemper- OUTDOOR_TEMP_LVL Outdoor temperature changed, value is in degrees C or F depending on weather scale atureEvent processRainfallEvent WEATHERRAIN-<duration>,<value> Rain fall changed, where <duration> is DAY, WEEK, MONTH, YEAR, YTD and <value> is in inches (Imperial Scale) or cm (Metric Scale).
  • Page 168 Standard NetLinx API (SNAPI) R 1.8.0...

  • Page 169: Window

    Window Component Name: Window Interface: IWindowComponent IWindowComponent Component Functions: Name: Channel: Level: Command: Constant: Notes: addWindowCompo- WINDOWADD-<index>,<address> Add a window at a given index, where <index> is 1 through x and <address> is a win- nent(index,windowAd- dow address and x is the maximum supported window index (see specific module doc- dress) umentation) adjustBrightness(1)
  • Page 170 Component Functions: Name: Channel: Level: Command: Constant: Notes: getZOrder() ?WINDOWZORDER Get the Z-order. Responds with WINDOWZORDER-<value> where <value> is 1 to the maximum z-order of the device, 1 is the top-most z-order (see specific module docu- mentation) pan(DOWN) PAN_DN Momentary Function Channel: Image is moved down one step within the window when channel is activated pan(LEFT) PAN_LT...
  • Page 171 Listener Name: Window Listener Interface: IWindowComponentListener IWindowComponentListener Listener Functions: Name: Channel: Level: Command: Constant: Notes: processBrightnessEvent BRIGHT_LVL Brightness changed, range is 0-255 processColorEvent COLOR_LVL Color changed, range is 0-255 processContrastEvent CONTRAST_LVL Contrast changed, range is 0-255 processFreezeEvent PIC_FREEZE_FB Feedback Channel: Freeze is on if channel is on processImageEvent IMAGE- Image position and/or size changed where <source>...
  • Page 172 Standard NetLinx API (SNAPI) R 1.8.0...
  • Page 174 033-004-2993 9/06 ©2006 AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time. 93-0070-59...

This manual is also suitable for:

Cafe duet

Table of Contents