User Guide

ManualsBrandsAMX ManualsOtherCAFE DUET STANDARD NETLINX API (SNAPI) DEVICES

Standard NetLinx API

(SNAPI) R 1.8.0

Devices

instruction manual

last revision: 8-29-06

Document ID: 033-004-2994

Summary of content (344 pages)

PAGE 1
instruction manual Standard NetLinx API (SNAPI) R 1.8.
PAGE 2
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.
PAGE 3
Table of Contents Interfacing with Standard NetLinx API (SNAPI) .................................................... 1 Overview ........................................................................................................................... 1 Programming..................................................................................................................... 4 Channel and Level Ranges ...............................................................................................
PAGE 4
Motor ............................................................................................................................. 165 Multi Window ................................................................................................................. 169 Pool Spa........................................................................................................................ 181 Power Device ...................................................................................................
PAGE 5
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.
PAGE 6
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 ().
PAGE 7
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 8
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.
PAGE 9
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.
PAGE 10
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.
PAGE 11
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.
PAGE 12
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
PAGE 13
Amplifier IAmplifierComponent IAmplifierComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Amplifier Interface: IAmplifier Amplifier Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSI
PAGE 14
Amplifier Functions (Cont.
PAGE 15
Amplifier Functions (Cont.
PAGE 16
12 Standard NetLinx API (SNAPI) R 1.8.
PAGE 17
Audio Conferencer IAudioConferencerComponent IAudioConferencerComponentListener IDialerComponent IDialerComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPhonebookComponent IPhonebookComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Audio Conferencer Interface: IAudioConferencer Audio Conferencer Functions Name Component cyclePrivacy() IAudioConferencerComponent setPrivacyOn(state) Constant Notes
PAGE 18
Audio Conferencer Functions (Cont.
PAGE 19
Audio Conferencer Functions (Cont.
PAGE 20
Audio Conferencer Functions (Cont.
PAGE 21
Audio Conferencer Functions (Cont.
PAGE 22
Audio Conferencer Functions (Cont.
PAGE 23
Audio Conferencer Functions (Cont.
PAGE 24
Audio Conferencer Functions (Cont.) Name Component loadProperties(fileName) IModuleComponent LOADPROPERTY Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules.
PAGE 25
Audio Conferencer Functions (Cont.) Name Component queryDB(si) IPhonebookComponent PHONEBOOKNEXT[,,] Request next records starting with record for the phonebook search associated with search key . If is not present, it is assumed to be 1. If is not present, it is assumed th be the next record in the search result set based on the last PHONEBOOKNEXT or PHONEBOOKPREV command.
PAGE 26
Audio Conferencer Functions (Cont.) Name Component updateRecord(sdr) IPhonebookComponent PHONEBOOKUPDATE,, Update phonebook record with index/id of , where is the new name and is the new number processCloseEvent(String) IPhonebookComponentListener PHONEBOOKCLOSESEARCH- The search associated with search key have been closed. No more operations can be performed against this search.
PAGE 27
Audio Conferencer Functions (Cont.
PAGE 28
24 Standard NetLinx API (SNAPI) R 1.8.
PAGE 29
Audio Mixer IAudioMixerComponent IAudioMixerComponentListener IGainComponent IGainComponentListener IModuleComponent IModuleComponentListener ISwitcherComponent ISwitcherComponentListener IVolumeComponent IVolumeComponentListener Name: Audio Mixer Interface: IAudioMixer Audio Mixer Functions Name Component getAudioMixerCrosspoint(input,output) IAudioMixerComponent ?XPOINT, Query for Audio Mixer Crosspoint, responds with XPOINT,, where is 0 to 255, i
PAGE 30
Audio Mixer Functions (Cont.) Name Component setAudioMixerCrosspointMuteOn(input,output,state) IAudioMixerComponent Channel Level Command XPOINTMUTE,, Set Audio Mixer Crosspoint Mute for and where is 0 (un-muted) or 1 (muted).
PAGE 31
Audio Mixer Functions (Cont.
PAGE 32
Audio Mixer Functions (Cont.) Name Component getOutput(sl,input) ISwitcherComponent ?OUTPUT[,] Query for the outputs connected to an input, respond with SWITCHLIO,Ö where is ALL, VIDEO, or AUDIO and is 0 if there is no connection. If is not supplied, ALL will be assumed.
PAGE 33
Audio Mixer Functions (Cont.
PAGE 34
30 Standard NetLinx API (SNAPI) R 1.8.
PAGE 35
Audio Processor IAudioProcessorComponent IAudioProcessorComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener Name: Audio Processor Interface: IAudioProcessor Audio Processor Functions Name Component addAudioProcessorComponent(index,audioProcessorAddress) IAudioProcessorComponent adjustAudioProcessorLevel(1) IAudioProcessorComponent 24 AUDIOPROC_LEVEL_UP Ramping Channel: Audio Processor level is incremented when channel is activated adjustAudioProcesso
PAGE 36
Audio Processor Functions (Cont.) Name Component getAudioProcessorOutput(input) IAudioProcessorComponent ?OUTPUT- Query for the outputs connected to an input, respond with SWITCHLIO,Ö where is AUDIO and is 0 if there is no connection.
PAGE 37
Audio Processor Functions (Cont.) Name Component switchAudioProcessorInputToOutput(input,output[]) IAudioProcessorComponent AIO Switch to one or more s for switcher level Audio. Use 0 for disconnect. processAudioProcessorCrosspointEvent(int,int,int) IAudioProcessorComponentListener XPOINT,, Audio Processor crosspoint changed for to one or more s where is 0 to 255.
PAGE 38
Audio Processor Functions (Cont.) Name Component setDeviceDateTime(date) IModuleComponent CLOCK- Set the device date/time. setPassbackOn(boolean) IModuleComponent PASSBACK- Set the passback state where is 1 or 0.
PAGE 39
Audio Processor State Charts processPowerEvent State Channel 255 OFF OFF ON ON Standard NetLinx API (SNAPI) R 1.8.
PAGE 40
36 Standard NetLinx API (SNAPI) R 1.8.
PAGE 41
Audio Tape IAudioTapeComponent IAudioTapeComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ITapeTransportComponent ITapeTransportComponentListener Name: Audio Tape Interface: IAudioTape Audio Tape Functions Name Component cycleAudioTapeRecordMute() IAudioTapeComponent cycleAudioTapeSide() Constant Notes 128 CASS_RECORD_MUTE Momentary Function Channel: Cycle record mute when channel is activated IAudioTapeComponent 42 CASS_TAPE_SIDE Momentary Fu
PAGE 42
Audio Tape Functions (Cont.) Name Component loadProperties(fileName) IModuleComponent LOADPROPERTY Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules.
PAGE 43
Audio Tape Functions (Cont.
PAGE 44
Audio Tape Functions (Cont.
PAGE 45
Audio Tape State Charts processPowerEvent State Channel 255 OFF OFF ON ON 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 STOP OFF PAUSE OFF FF REW OFF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF OFF OFF OFF OFF ON OFF OFF OFF OFF OFF SEARCH_FWD OFF OFF OFF
PAGE 46
42 Standard NetLinx API (SNAPI) R 1.8.
PAGE 47
Audio Tuner Device IAudioTunerDeviceComponent IAudioTunerDeviceComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ITunerStationComponent ITunerStationComponentListener Name: Audio Tuner Device Interface: IAudioTunerDevice Audio Tuner Device Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION
PAGE 48
Audio Tuner Device Functions (Cont.
PAGE 49
Audio Tuner Device Functions (Cont.
PAGE 50
Audio Tuner Device Functions (Cont.
PAGE 51
Audio Tuner Device Functions (Cont.) Name Component processTunerComponentPropertyEvent(String[]) ITunerStationComponentListener Channel Level Command TUNERCOMPONENTPROPERTY,, Constant Notes Response to ?TUNERPROPERTY Audio Tuner Device State Charts processPowerEvent State Channel 255 OFF OFF ON ON Standard NetLinx API (SNAPI) R 1.8.
PAGE 52
48 Standard NetLinx API (SNAPI) R 1.8.
PAGE 53
Camera ICameraComponent ICameraComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener Name: Camera Interface: ICamera Camera Functions Name Component cycleAutoFocus() ICameraComponent cycleAutoIris() Constant Notes 172 AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated ICameraComponent 173 AUTO_IRIS Momentary Function Channel: Cycle auto iris when channel is activated cycleCameraPreset() ICameraComponent 177 CAM_PR
PAGE 54
Camera Functions (Cont.
PAGE 55
Camera Functions (Cont.
PAGE 56
Camera Functions (Cont.
PAGE 57
Camera Functions (Cont.
PAGE 58
54 Standard NetLinx API (SNAPI) R 1.8.
PAGE 59
Digital Media Decoder IDigitalMediaDecoderComponent IDigitalMediaDecoderComponentListener IDiscTransportComponent IDiscTransportComponentListener IMediaDeviceComponent IMediaDeviceComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Digital Media Decoder Interface: IDigitalMediaDecoder Digital Media Decoder Functions Name Component cycleScanSpeed() IDiscTransportComponent
PAGE 60
Digital Media Decoder Functions (Cont.
PAGE 61
Digital Media Decoder Functions (Cont.) Name Component processTrackCounterEvent(MediaTime) IDiscTransportComponentListener TRACKCOUNTER Track counter changed, where is a String in the format [-]hh:mm:ss.ff processTrackInfoEvent(TrackInfo) IDiscTransportComponentListener TRACKINFO,, Track info changed, where is track number, is a track duration String in the format [-]hh:mm:ss.ff and is the dusc number the track belongs to.
PAGE 62
Digital Media Decoder Functions (Cont.) Name Component processMediaDeviceCounterEvent(MediaTime) IMediaDeviceComponentListener Channel Level Command processMediaDevicePropertiesEvent(Proper- IMediaDeviceComponentListener ties) Constant Notes MEDIACOUNTER Media counter changed, where is a String in the format [-]hh:mm:ss.ff DECODEPROP, Media property value where is the property key and is the property value. One command is returned for each key.
PAGE 63
Digital Media Decoder Functions (Cont.
PAGE 64
Digital Media Decoder Functions (Cont.
PAGE 65
Digital Media Decoder Functions (Cont.
PAGE 66
Digital Media Decoder Functions (Cont.
PAGE 67
Digital Media Decoder Functions (Cont.
PAGE 68
Digital Media Decoder Functions (Cont.
PAGE 69
Digital Media Decoder Functions (Cont.
PAGE 70
Digital Media Decoder 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 OFF
PAGE 71
Digital Media Encoder IDigitalMediaEncoderComponent IDigitalMediaEncoderComponentListener IDiscTransportComponent IDiscTransportComponentListener IGainComponent IGainComponentListener IModuleComponent IModuleComponentListener IOutputStreamComponent IOutputStreamComponentListener IPowerComponent IPowerComponentListener Name: Digital Media Encoder Interface: IDigitalMediaEncoder Digital Media Encoder Functions Name Component cycleScanSpeed() IDiscTransportComponent getTrackInfo() IDiscTransportComponent
PAGE 72
Digital Media Encoder Functions (Cont.
PAGE 73
Digital Media Encoder Functions (Cont.) Name Component processTrackInfoEvent(TrackInfo) IDiscTransportComponentListener Channel Level Command TRACKINFO,, Track info changed, where is track number, is a track duration String in the format [-]hh:mm:ss.ff and is the dusc number the track belongs to.
PAGE 74
Digital Media Encoder Functions (Cont.) Name Component setDeviceDateTime(date) IModuleComponent CLOCK- Set the device date/time. setPassbackOn(boolean) IModuleComponent PASSBACK- Set the passback state where is 1 or 0.
PAGE 75
Digital Media Encoder Functions (Cont.) Name Component processOutputStreamPropertiesEvent(Properties) IOutputStreamComponentListener ENCODEPROP, Output Stream Property value where is the property key and is the property value. One command is returned for each key. processOutputStreamSinkAddEvent(URL) IOutputStreamComponentListener ENCODESINKADD Output Stream Sink added where is the URL of the added sink.
PAGE 76
Digital Media Encoder 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 OFF
PAGE 77
Digital Media Server IDigitalMediaServerComponent IDigitalMediaServerComponentListener IDiscTransportComponent IDiscTransportComponentListener IGainComponent IGainComponentListener IMediaDBComponent IMediaDBComponentListener IMediaDeviceComponent IMediaDeviceComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IOutputStreamComponent IOutputStreamComponentListener IPowerComponent IPowerComponentListener IVolumeComponent IVolumeComponentListener Name: Digital Media
PAGE 78
Digital Media Server Functions (Cont.
PAGE 79
Digital Media Server Functions (Cont.
PAGE 80
Digital Media Server Functions (Cont.) Name Component queryDB(mdbss) IMediaDBComponent MEDIADBNEXT- Request next record (count =1) starting with the next record for the media search associated with search key . If is not present, it is assumed th be the next record in the search result set based on the last MEDIADBNEXT or MEDIADBPREV command.
PAGE 81
Digital Media Server Functions (Cont.) Name Component queryDB(mdbss, count) IMediaDBComponent MEDIADBREFRESH, Refresh record starting with the last starting position used with a MEDIADBNEXT or MEDIADBPREV command for the media search associated with search key .
PAGE 82
Digital Media Server Functions (Cont.) Name Component updateRecord(rec) IMediaDBComponent MEDIADBUPDATE,,[,] Update media record with record id of , where is the new name and is the new record type, i.e.
PAGE 83
Digital Media Server Functions (Cont.) Name Component queryMediaDeviceProperties() IMediaDeviceComponent Channel Level Command ?DECODEPROPS Query for all Media Device Properties, responds with multiple DECODEPROP,, one for each property, where is the property key and is the property value.
PAGE 84
Digital Media Server Functions (Cont.
PAGE 85
Digital Media Server Functions (Cont.
PAGE 86
Digital Media Server Functions (Cont.
PAGE 87
Digital Media Server Functions (Cont.
PAGE 88
Digital Media Server Functions (Cont.
PAGE 89
Digital Media Server Functions (Cont.
PAGE 90
Digital Media Server Functions (Cont.) Name Component getOutputStreamSinks() IOutputStreamComponent ?ENCODESINK Query for Output Stream Sinks, responds with multiple ENCODESINK-, one for each output stream sink, where is the URL of the sink/destination. getOutputStreamSource() IOutputStreamComponent ?ENCODESOURCE Query for Output Stream Source, responds with ENCODESOURCE- where is the URL for the source.
PAGE 91
Digital Media Server Functions (Cont.
PAGE 92
Digital Media Server 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 OFF
PAGE 93
Digital Satellite System IDigitalSatelliteSystemComponent IDigitalSatelliteSystemComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ITunerStationComponent ITunerStationComponentListener Name: Digital Satellite System Interface: IDigitalSatelliteSystem Digital Satellite System Functions Name Component moveMenuCursor(UP) IMenuComponent moveMenuCursor(DOWN) Constant Notes 45 MENU_UP Momentary Function Channel: Move
PAGE 94
Digital Satellite System Functions (Cont.
PAGE 95
Digital Satellite System Functions (Cont.
PAGE 96
Digital Satellite System Functions (Cont.
PAGE 97
Digital Satellite System Functions (Cont.
PAGE 98
Digital Satellite System Functions (Cont.
PAGE 99
Digital Satellite System Functions (Cont.
PAGE 100
Digital Satellite System Functions (Cont.
PAGE 101
Digital Satellite System Functions (Cont.) Name Component processBandEvent(TunerBand) ITunerStationComponentListener BAND- Band changed, where is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV processStationEvent(String) ITunerStationComponentListener XCH- Station changed, where is a station string such as "501", "103.7" or "5.
PAGE 102
Digital Satellite System Functions (Cont.) Name Component processTunerComponentPropertyEvent(String[]) ITunerStationComponentListener Channel Level Command TUNERCOMPONENTPROPERTY,, Constant Notes Response to ?TUNERPROPERTY Digital Satellite System State Charts processPowerEvent State Channel 255 OFF OFF ON ON 98 Standard NetLinx API (SNAPI) R 1.8.
PAGE 103
Digital Video Recorder IDigitalVideoRecorderComponent IDigitalVideoRecorderComponentListener IDiscTransportComponent IDiscTransportComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener ITunerStationComponent ITunerStationComponentListener Name: Digital Video Recorder Interface: IDigitalVideoRecorder Digital Video Recorder Functions Name Component cycleScanSpeed() IDis
PAGE 104
Digital Video Recorder Functions (Cont.
PAGE 105
Digital Video Recorder Functions (Cont.) Name Component processTrackCounterEvent(MediaTime) IDiscTransportComponentListener TRACKCOUNTER Track counter changed, where is a String in the format [-]hh:mm:ss.ff processTrackInfoEvent(TrackInfo) IDiscTransportComponentListener TRACKINFO,, Track info changed, where is track number, is a track duration String in the format [-]hh:mm:ss.ff and is the dusc number the track belongs to.
PAGE 106
Digital Video Recorder Functions (Cont.
PAGE 107
Digital Video Recorder Functions (Cont.
PAGE 108
Digital Video Recorder Functions (Cont.
PAGE 109
Digital Video Recorder Functions (Cont.
PAGE 110
Digital Video Recorder Functions (Cont.
PAGE 111
Digital Video Recorder Functions (Cont.
PAGE 112
Digital Video Recorder Functions (Cont.
PAGE 113
Digital Video Recorder Functions (Cont.
PAGE 114
Digital Video Recorder Functions (Cont.
PAGE 115
Digital Video Recorder Functions (Cont.) Name Component processBandEvent(TunerBand) ITunerStationComponentListener BAND- Band changed, where is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV processStationEvent(String) ITunerStationComponentListener XCH- Station changed, where is a station string such as "501", "103.7" or "5.
PAGE 116
Digital Video Recorder Functions (Cont.
PAGE 117
Disc Device IDiscDeviceComponent IDiscDeviceComponentListener IDiscTransportComponent IDiscTransportComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener Name: Disc Device Interface: IDiscDevice Disc Device Functions Name Component cycleDiscTray() IDiscDeviceComponent cycleRandom() Constant Notes 120 DISC_TRAY Momentary Function Channel: Open or Close the disc tray when the channel is activated IDiscDeviceComponen
PAGE 118
Disc Device Functions (Cont.) Name Component queryTitleProperty(key) IDiscDeviceComponent ?TITLEPROP- Query for a title property, responds with TITLEPROP-, command setDisc(discNumber) IDiscDeviceComponent SETDISC- Set disc number to , where is 1 to where x is the disc capacity.
PAGE 119
Disc Device Functions (Cont.) Name Component processDiscInfoEvent(DiscInfo) IDiscDeviceComponentListener DISCINFO,,<# of titles>,<#of tracks>,, Disc info changed, where is disc number, is a disc duration String in the format [-]hh:mm:ss.ff, <# of tracks> is the number of titles in this disc, <# of tracks> is the number of tracks in this disc, is the disc type (AUDIO_ONLY, VIDEO_ONLY, AUDIOVIDEO) and is the disc database id.
PAGE 120
Disc Device Functions (Cont.
PAGE 121
Disc Device Functions (Cont.
PAGE 122
Disc Device Functions (Cont.
PAGE 123
Disc Device Functions (Cont.
PAGE 124
Disc Device Functions (Cont.
PAGE 125
Disc Device Functions (Cont.
PAGE 126
Disc Device Functions (Cont.
PAGE 127
Disc Device Functions (Cont.
PAGE 128
Disc Device State Charts processRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON OFF OFF RANDOM_ALL OFF ON OFF RANDOM_OFF OFF OFF ON processRepeatStateEvent State Channel 181 Channel 182 Channel 183 Channel 184 REPEAT_DISC ON OFF OFF OFF REPEAT_TRACK OFF ON OFF OFF REPEAT_ALL OFF OFF ON OFF REPEAT_OFF OFF OFF OFF ON processDiscTransportEvent State Channel 241 Channel 242 Channel 243 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY
PAGE 129
Document Camera IDocumentCameraComponent IDocumentCameraComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener Name: Document Camera Interface: IDocumentCamera Document Camera Functions Name Component cycleAutoFocus() IDocumentCameraComponent cycleAutoIris() Constant Notes 172 AUTO_FOCUS Momentary Function Channel: Cycle auto focus when channel is activated IDocumentCameraComponent 173 AUTO_IRIS
PAGE 130
Document Camera Functions (Cont.
PAGE 131
Document Camera Functions (Cont.) Name Component getProperty(key) IModuleComponent ?PROPERTY- Query for the value of property , respond with PROPERTY-, getVersion() IModuleComponent ?VERSION Query for the module version, responds with VERSION- loadProperties(fileName) IModuleComponent LOADPROPERTY Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules.
PAGE 132
Document Camera Functions (Cont.
PAGE 133
Document Camera Functions (Cont.
PAGE 134
Document Camera Functions (Cont.
PAGE 135
HVAC IHVACComponent IHVACComponentListener IModuleComponent IModuleComponentListener Name: HVAC Interface: IHVAC HVAC Functions Name Component addHVACComponent(index,hvacAddress) IHVACComponent cycleFanState() IHVACComponent 213 HVAC_FAN Momentary Function Channel: Cycle the fan state when channel is activated cycleHumidifyState() IHVACComponent 217 HVAC_HUMIDIFY_STATE Momentary Function Channel: Cycle the humidify state when channel is activated cycleHVACState() IHVACComponent 218 HVAC_ST
PAGE 136
HVAC Functions (Cont.
PAGE 137
HVAC Functions (Cont.
PAGE 138
HVAC Functions (Cont.
PAGE 139
HVAC Functions (Cont.
PAGE 140
HVAC 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 Channel 22
PAGE 141
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 Standard NetLinx API (SNAPI) R 1.8.
PAGE 142
138 Standard NetLinx API (SNAPI) R 1.8.
PAGE 143
IO Device IIODeviceComponent IIODeviceComponentListener IModuleComponent IModuleComponentListener Name: IO Device Interface: IIODevice IO Device Functions Name Component getIOChannelCount() IIODeviceComponent ?IOCHANNELCOUNT Query for the number of channels on an IO device, responds with IOCHANNELCOUNT getIOChannelDirection(io-chan) IIODeviceComponent ?IOCHANNELDIRECTION- Query for direction of the I/O channel, where is the integer channel number, responds with IOCHANNELDIRECTIO
PAGE 144
IO Device Functions (Cont.
PAGE 145
Keypad IKeypadComponent IKeypadComponentListener IModuleComponent IModuleComponentListener Name: Keypad Interface: IKeypad Keypad Functions Name Component addKeypadComponent(index,keypadAddress) IKeypadComponent 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) IKeypadComponent ?KEYPADADDR Query for the
PAGE 146
Keypad Functions (Cont.
PAGE 147
Keypad Functions (Cont.) Name Component processPassbackEvent(byte[]) IModuleComponentListener Channel Level Command Constant Notes When passback is on, each string received form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device.
PAGE 148
144 Standard NetLinx API (SNAPI) R 1.8.
PAGE 149
Light IKeypadComponent IKeypadComponentListener ILightComponent ILightComponentListener IModuleComponent IModuleComponentListener Name: Light Interface: ILight Light Functions Name Component addKeypadComponent(index,keypadAddress) IKeypadComponent 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) IKeypadComponent
PAGE 150
Light Functions (Cont.
PAGE 151
Light Functions (Cont.
PAGE 152
Light Functions (Cont.
PAGE 153
Light Functions (Cont.
PAGE 154
Light Functions (Cont.) Name Component getVersion() IModuleComponent ?VERSION Query for the module version, responds with VERSION- loadProperties(fileName) IModuleComponent LOADPROPERTY Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules.
PAGE 155
Light 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.
PAGE 156
152 Standard NetLinx API (SNAPI) R 1.8.
PAGE 157
Monitor IDisplayComponent IDisplayComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IMonitorComponent IMonitorComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener IVolumeComponent IVolumeComponentListener Name: Monitor Interface: IMonitor Monitor Functions Name Component adjustBrightness(1) IDisplayComponent adjustBrightness(-1) Constant Notes 148 BRIGHT_UP Momentary Function Channel: Brightn
PAGE 158
Monitor Functions (Cont.
PAGE 159
Monitor Functions (Cont.
PAGE 160
Monitor Functions (Cont.
PAGE 161
Monitor Functions (Cont.
PAGE 162
Monitor Functions (Cont.
PAGE 163
Monitor Functions (Cont.
PAGE 164
Monitor Functions (Cont.
PAGE 165
Monitor Functions (Cont.) Name Component passThru(buffer) IModuleComponent PASSTHRU- Send a message directly to the device reinitialize() IModuleComponent REINIT Reinitialize communication with the device setDebugState(state) IModuleComponent DEBUG- Set the debug state where is 1-4 for ERROR, WARNING, DEBUG, INFO setDeviceDateTime(date) IModuleComponent CLOCK- Set the device date/time.
PAGE 166
Monitor Functions (Cont.
PAGE 167
Monitor Functions (Cont.
PAGE 168
Monitor Functions (Cont.
PAGE 169
Motor IModuleComponent IModuleComponentListener IMotorComponent IMotorComponentListener Name: Motor Interface: IMotor Motor Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY- Query for the value of property ,
PAGE 170
Motor Functions (Cont.
PAGE 171
Motor State Charts processMotorDirectionEvent State Channel 2 Channel 4 Channel 5 STOP ON OFF OFF OPEN OFF ON OFF OFF ON CLOSE OFF Standard NetLinx API (SNAPI) R 1.8.
PAGE 172
168 Standard NetLinx API (SNAPI) R 1.8.
PAGE 173
Multi Window IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IMultiWindowComponent IMultiWindowComponentListener IPowerComponent IPowerComponentListener IWindowComponent IWindowComponentListener Name: Multi Window Interface: IMultiWindow Multi Window Functions Name Component moveMenuCursor(UP) IMenuComponent moveMenuCursor(DOWN) Constant Notes 45 MENU_UP Momentary Function Channel: Move menu cursor UP IMenuComponent 46 MENU_DN Momentary Function Channel: Move me
PAGE 174
Multi Window Functions (Cont.
PAGE 175
Multi Window Functions (Cont.
PAGE 176
Multi Window Functions (Cont.
PAGE 177
Multi Window Functions (Cont.
PAGE 178
Multi Window Functions (Cont.
PAGE 179
Multi Window Functions (Cont.
PAGE 180
Multi Window Functions (Cont.
PAGE 181
Multi Window Functions (Cont.) Name Component getWindowSize() IWindowComponent ?WINDOW Query for the window size. Response with WINDOW-,,, getZOrder() IWindowComponent ?WINDOWZORDER Get the Z-order.
PAGE 182
Multi Window Functions (Cont.) Name Component setPictureMuteOn(state) IWindowComponent setSharpness(level) IWindowComponent setTint(level) IWindowComponent setWindow(pos,size) IWindowComponent WINDOW,,, Set the window position and size relative to the display where and are the display coordinates for the upper-left hand corner of the window and and are the size of the window to be displayed in the display.
PAGE 183
Multi Window Functions (Cont.) Name Component processWindowEvent(Position,Size) IWindowComponentListener Channel Level Command WINDOW,,, Constant Window position and/or size changed.
PAGE 184
180 Standard NetLinx API (SNAPI) R 1.8.
PAGE 185
Pool Spa IModuleComponent IModuleComponentListener IPoolSpaComponent IPoolSpaComponentListener Name: Pool Spa Interface: IPoolSpa Pool Spa Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY- Query for the value of p
PAGE 186
Pool Spa Functions (Cont.
PAGE 187
Pool Spa Functions (Cont.
PAGE 188
Pool Spa Functions (Cont.
PAGE 189
Pool Spa Functions (Cont.
PAGE 190
Pool Spa 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 OFF OFF O
PAGE 191
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.
PAGE 192
188 Standard NetLinx API (SNAPI) R 1.8.
PAGE 193
Power Device IModuleComponent IModuleComponentListener IPowerDeviceComponent IPowerDeviceComponentListener Name: Power Device Interface: IPowerDevice Power Device Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY-
PAGE 194
Power Device Functions (Cont.) Name Component processPassbackEvent(byte[]) IModuleComponentListener 190 Channel Level Command Constant Notes When passback is on, each string received form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device. Standard NetLinx API (SNAPI) R 1.7.
PAGE 195
Pre Amp Surround Sound Processor IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IPreAmpComponent IPreAmpComponentListener IPreAmpSurroundSoundProcessorComponent IPreAmpSurroundSoundProcessorComponentListener ISourceSelectComponent ISourceSelectComponentListener IVolumeComponent IVolumeComponentListener Name: Pre Amp Surround Sound Processor Interface: IPreAmpSurroundSoundProcessor Pre Amp Surround Sound Processor Functions Name Compo
PAGE 196
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 197
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 198
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 199
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 200
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 201
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 202
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 203
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 204
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 205
Pre Amp Surround Sound Processor Functions (Cont.
PAGE 206
202 Standard NetLinx API (SNAPI) R 1.8.
PAGE 207
Receiver IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IPreAmpComponent IPreAmpComponentListener IReceiverComponent IReceiverComponentListener ISourceSelectComponent ISourceSelectComponentListener ITunerStationComponent ITunerStationComponentListener IVolumeComponent IVolumeComponentListener Name: Receiver Interface: IReceiver Receiver Functions Name Component moveMenuCursor(UP) IMenuComponent moveMenuCursor(DOWN) Constant Note
PAGE 208
Receiver Functions (Cont.
PAGE 209
Receiver Functions (Cont.
PAGE 210
Receiver Functions (Cont.
PAGE 211
Receiver Functions (Cont.
PAGE 212
Receiver Functions (Cont.
PAGE 213
Receiver Functions (Cont.
PAGE 214
Receiver Functions (Cont.
PAGE 215
Receiver Functions (Cont.
PAGE 216
Receiver Functions (Cont.
PAGE 217
Receiver Functions (Cont.) Name Component getStation() ITunerStationComponent ?XCH Query for station, responds with XCH- where is a station string such as "501", "103.7" or "5.
PAGE 218
Receiver Functions (Cont.) Name Component setBand(tb) ITunerStationComponent BAND- Set band, where is AM,FM,FM_MONO,SATELLITE_RADIO,L ONG_WAVE,MEDIUM_WAVE,SHORT_W AVE,TV setStation(station) ITunerStationComponent XCH- Set station, where is a station string such as "501", "103.7" or "5.
PAGE 219
Receiver Functions (Cont.
PAGE 220
Receiver State Charts processPowerEvent State Channel 255 OFF OFF ON ON 216 Standard NetLinx API (SNAPI) R 1.8.
PAGE 221
Relay Device IModuleComponent IModuleComponentListener IRelayDeviceComponent IRelayDeviceComponentListener Name: Relay Device Interface: IRelayDevice Relay Device Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY-
PAGE 222
Relay Device Functions (Cont.
PAGE 223
Security System IModuleComponent IModuleComponentListener ISecuritySystemComponent ISecuritySystemComponentListener Name: Security System Interface: ISecuritySystem Security System Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent
PAGE 224
Security System Functions (Cont.
PAGE 225
Security System Functions (Cont.
PAGE 226
222 Standard NetLinx API (SNAPI) R 1.8.
PAGE 227
Sensor Device IModuleComponent IModuleComponentListener ISensorComponent ISensorComponentListener Name: Sensor Device Interface: ISensorDevice Sensor Device Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY- Query
PAGE 228
Sensor Device Functions (Cont.) Name Component processPassbackEvent(byte[]) IModuleComponentListener processSensorStateEvent(ON) ISensorComponentListener processSensorValueEvent(int) ISensorComponentListener Channel Level Command Constant Notes When passback is on, each string received form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device.
PAGE 229
Settop Box IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISettopBoxComponent ISettopBoxComponentListener ITunerStationComponent ITunerStationComponentListener IVolumeComponent IVolumeComponentListener Name: Settop Box Interface: ISettopBox Settop Box Functions Name Component moveMenuCursor(UP) IMenuComponent moveMenuCursor(DOWN) Constant Notes 45 MENU_UP Momentary Function Channel: Move menu cursor UP IMenuComponent 46 ME
PAGE 230
Settop Box Functions (Cont.
PAGE 231
Settop Box Functions (Cont.
PAGE 232
Settop Box Functions (Cont.
PAGE 233
Settop Box Functions (Cont.
PAGE 234
Settop Box Functions (Cont.
PAGE 235
Settop Box Functions (Cont.
PAGE 236
Settop Box Functions (Cont.
PAGE 237
Settop Box Functions (Cont.) Name Component setStation(station) ITunerStationComponent XCH- Set station, where is a station string such as "501", "103.7" or "5.
PAGE 238
Settop Box Functions (Cont.
PAGE 239
Settop Box State Charts processPowerEvent State Channel 255 OFF OFF ON ON Standard NetLinx API (SNAPI) R 1.8.
PAGE 240
236 Standard NetLinx API (SNAPI) R 1.8.
PAGE 241
Slide Projector ILampComponent ILampComponentListener IModuleComponent IModuleComponentListener ISlideProjectorComponent ISlideProjectorComponentListener Name: Slide Projector Interface: ISlideProjector Slide Projector Functions Name Component cycleLampPower() ILampComponent getCoolDownTime() ILampComponent ?COOLDOWN Query for cool down time, responds with COOLDOWN- where is in seconds getLampTime() ILampComponent ?LAMPTIME Query for lamp time, responds with LAMPTIME- where
PAGE 242
Slide Projector Functions (Cont.
PAGE 243
Slide Projector Functions (Cont.
PAGE 244
240 Standard NetLinx API (SNAPI) R 1.8.
PAGE 245
Switcher IGainComponent IGainComponentListener IModuleComponent IModuleComponentListener ISwitcherComponent ISwitcherComponentListener IVolumeComponent IVolumeComponentListener Name: Switcher Interface: ISwitcher Switcher Functions Name Component cycleGainMute() IGainComponent Channel Level Command 144 5 Constant Notes GAIN_MUTE Momentary Function Channel: Cycle gain mute when channel is activated setGain(level) IGainComponent GAIN_LVL Set gain, range is 0-255 setGainMuteOn(state) IGainCompon
PAGE 246
Switcher Functions (Cont.) Name Component passThru(buffer) IModuleComponent PASSTHRU- Send a message directly to the device reinitialize() IModuleComponent REINIT Reinitialize communication with the device setDebugState(state) IModuleComponent DEBUG- Set the debug state where is 1-4 for ERROR, WARNING, DEBUG, INFO setDeviceDateTime(date) IModuleComponent CLOCK- Set the device date/time.
PAGE 247
Switcher Functions (Cont.) Name Component switchInputToOutput(AUDIO,input,output[]) ISwitcherComponent AIO Switch to one or more s for switcher level Audio. Use 0 for disconnect. switchInputToOutput(ALL,input,output[]) ISwitcherComponent CIO Switch to one or more s for switcher level All. Use 0 for disconnect.
PAGE 248
Switcher Functions (Cont.) Name Component Constant Notes processVolumeRampEvent(UP) IVolumeComponentListener 24 VOL_UP_FB Feedback Channel: Volume is ramping up while channel is on processVolumeRampEvent(DOWN) IVolumeComponentListener 25 VOL_DN_FB Feedback Channel: Volume is ramping down while channel is on 244 Channel Level Command Standard NetLinx API (SNAPI) R 1.8.
PAGE 249
Text Keypad IKeypadComponent IKeypadComponentListener IModuleComponent IModuleComponentListener ITextKeypadComponent ITextKeypadComponentListener Name: Text Keypad Interface: ITextKeypad Text Keypad Functions Name Component addKeypadComponent(index,keypadAddress) IKeypadComponent 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) getKeypadComponen
PAGE 250
Text Keypad Functions (Cont.
PAGE 251
Text Keypad Functions (Cont.) Name Component processDebugEvent(int) IModuleComponentListener Channel Level Command Constant processDeviceOnLineEvent(boolean) IModuleComponentListener processPassbackEvent(byte[]) IModuleComponentListener clearDisplay() ITextKeypadComponent TEXT- Clear display.
PAGE 252
248 Standard NetLinx API (SNAPI) R 1.8.
PAGE 253
TV IDisplayComponent IDisplayComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener ITunerStationComponent ITunerStationComponentListener ITVComponent ITVComponentListener IVolumeComponent IVolumeComponentListener Name: TV Interface: ITV TV Functions Name Component adjustBrightness(1) IDisplayComponent adjustBrightness(-1) Constant Notes 148 BRIGHT_UP Momentary F
PAGE 254
TV Functions (Cont.
PAGE 255
TV Functions (Cont.
PAGE 256
TV Functions (Cont.
PAGE 257
TV Functions (Cont.
PAGE 258
TV Functions (Cont.
PAGE 259
TV Functions (Cont.
PAGE 260
TV Functions (Cont.
PAGE 261
TV Functions (Cont.) Name Component loadProperties(fileName) IModuleComponent LOADPROPERTY passThru(buffer) IModuleComponent PASSTHRU- Send a message directly to the device reinitialize() IModuleComponent REINIT Reinitialize communication with the device setDebugState(state) IModuleComponent DEBUG- Set the debug state where is 1-4 for ERROR, WARNING, DEBUG, INFO setDeviceDateTime(date) IModuleComponent CLOCK- Set the device date/time.
PAGE 262
TV Functions (Cont.
PAGE 263
TV Functions (Cont.
PAGE 264
TV Functions (Cont.
PAGE 265
TV Functions (Cont.
PAGE 266
TV Functions (Cont.
PAGE 267
TV Functions (Cont.
PAGE 268
264 Standard NetLinx API (SNAPI) R 1.8.
PAGE 269
Utility IModuleComponent IModuleComponentListener IUtilityComponent IUtilityComponentListener Name: Utility Interface: IUtility Utility Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY- Query for the value of prop
PAGE 270
Utility Functions (Cont.) Name Component processPassbackEvent(byte[]) IModuleComponentListener 266 Channel Level Command Constant Notes When passback is on, each string received form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device. Standard NetLinx API (SNAPI) R 1.8.
PAGE 271
VCR IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener ITapeTransportComponent ITapeTransportComponentListener ITunerStationComponent ITunerStationComponentListener IVCRComponent IVCRComponentListener Name: VCR Interface: IVCR VCR Functions Name Component moveMenuCursor(UP) IMenuComponent moveMenuCursor(DOWN) Constant Notes 45 MENU_UP Momentary Function Channel: Move menu curs
PAGE 272
VCR Functions (Cont.
PAGE 273
VCR Functions (Cont.
PAGE 274
VCR Functions (Cont.
PAGE 275
VCR Functions (Cont.
PAGE 276
VCR Functions (Cont.
PAGE 277
VCR Functions (Cont.
PAGE 278
VCR Functions (Cont.
PAGE 279
VCR Functions (Cont.
PAGE 280
VCR Functions (Cont.
PAGE 281
VCR Functions (Cont.
PAGE 282
VCR Functions (Cont.
PAGE 283
VCR Functions (Cont.
PAGE 284
VCR State Charts processPowerEvent State Channel 255 OFF OFF ON ON processTapeTransportEvent State Channel 241 Channel 242 Channel 243 Channel 244 Channel 245 Channel 246 Channel 247 Channel 248 Channel 249 Channel 250 PLAY ON STOP OFF PAUSE OFF FF OFF OFF OFF REW OFF OFF OFF SEARCH_FWD OFF OFF OFF OFF OFF SEARCH_REV OFF OFF OFF OFF OFF RECORD OFF OFF OFF OFF OFF OFF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF OFF
PAGE 285
Video Conferencer ICameraComponent ICameraComponentListener IDialerComponent IDialerComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPhonebookComponent IPhonebookComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener IVideoConferencerComponent IVideoConferencerComponentListener IVolumeComponent IVolumeComponentListener Name: Video Conferencer Interface: IVideoConferencer Video Conferencer Functions Na
PAGE 286
Video Conferencer Functions (Cont.
PAGE 287
Video Conferencer Functions (Cont.
PAGE 288
Video Conferencer Functions (Cont.
PAGE 289
Video Conferencer Functions (Cont.
PAGE 290
Video Conferencer Functions (Cont.
PAGE 291
Video Conferencer Functions (Cont.
PAGE 292
Video Conferencer Functions (Cont.
PAGE 293
Video Conferencer Functions (Cont.
PAGE 294
Video Conferencer Functions (Cont.
PAGE 295
Video Conferencer Functions (Cont.) Name Component setPassbackOn(boolean) IModuleComponent PASSBACK- Set the passback state where is 1 or 0.
PAGE 296
Video Conferencer Functions (Cont.) Name Component queryDB(si) IPhonebookComponent PHONEBOOKPREV[,] Request previous records for the phonebook search associated with search key . If is not present, it is assumed to be 1. Responses with PHONEBOOKPREV-,, where is the search key, is the number of records to expect and is the position of the first record to be returned between 1 through the total number of records.
PAGE 297
Video Conferencer Functions (Cont.) Name Component processQueryDBEvent(PhonebookRecord) IPhonebookComponentListener PHONEBOOKRECORD,,<#>,, Phonebook record for search with search key . is the record ID, <#> is the record position from 1 to the total number of records, is the name/label and is the phone number.
PAGE 298
Video Conferencer Functions (Cont.
PAGE 299
Video Conferencer Functions (Cont.
PAGE 300
Video Conferencer Functions (Cont.
PAGE 301
Video Conferencer Functions (Cont.
PAGE 302
298 Standard NetLinx API (SNAPI) R 1.8.
PAGE 303
Video Processor IDisplayComponent IDisplayComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener ISourceSelectComponent ISourceSelectComponentListener IVideoProcessorComponent IVideoProcessorComponentListener Name: Video Processor Interface: IVideoProcessor Video Processor Functions Name Component adjustBrightness(1) IDisplayComponent adjustBrightness(-1) Constant Notes 148 BRIGHT_UP Momentary Function Channel: Brig
PAGE 304
Video Processor Functions (Cont.
PAGE 305
Video Processor Functions (Cont.
PAGE 306
Video Processor Functions (Cont.
PAGE 307
Video Processor Functions (Cont.
PAGE 308
Video Processor Functions (Cont.
PAGE 309
Video Processor Functions (Cont.
PAGE 310
Video Processor Functions (Cont.
PAGE 311
Video Processor Functions (Cont.) Name Component passThru(buffer) IModuleComponent PASSTHRU- Send a message directly to the device reinitialize() IModuleComponent REINIT Reinitialize communication with the device setDebugState(state) IModuleComponent DEBUG- Set the debug state where is 1-4 for ERROR, WARNING, DEBUG, INFO setDeviceDateTime(date) IModuleComponent CLOCK- Set the device date/time.
PAGE 312
Video Processor Functions (Cont.
PAGE 313
Video Processor Functions (Cont.
PAGE 314
Video Processor Functions (Cont.
PAGE 315
Video Projector IDisplayComponent IDisplayComponentListener ILampComponent ILampComponentListener IMenuComponent IMenuComponentListener IModuleComponent IModuleComponentListener ISourceSelectComponent ISourceSelectComponentListener IVideoProjectorComponent IVideoProjectorComponentListener IVolumeComponent IVolumeComponentListener Name: Video Projector Interface: IVideoProjector Video Projector Functions Name Component adjustBrightness(1) IDisplayComponent adjustBrightness(-1) Constant Notes 148 BRI
PAGE 316
Video Projector Functions (Cont.
PAGE 317
Video Projector Functions (Cont.
PAGE 318
Video Projector Functions (Cont.
PAGE 319
Video Projector Functions (Cont.
PAGE 320
Video Projector Functions (Cont.
PAGE 321
Video Projector Functions (Cont.
PAGE 322
Video Projector Functions (Cont.
PAGE 323
Video Projector Functions (Cont.
PAGE 324
Video Projector Functions (Cont.) Name Component setPassbackOn(boolean) IModuleComponent PASSBACK- Set the passback state where is 1 or 0.
PAGE 325
Video Projector Functions (Cont.
PAGE 326
Video Projector Functions (Cont.
PAGE 327
Video Projector Functions (Cont.
PAGE 328
324 Standard NetLinx API (SNAPI) R 1.8.
PAGE 329
Video Wall IModuleComponent IModuleComponentListener IPowerComponent IPowerComponentListener IVideoWallComponent IVideoWallComponentListener IWindowComponent IWindowComponentListener Name: Video Wall Interface: IVideoWall Video Wall Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVE
PAGE 330
Video Wall Functions (Cont.
PAGE 331
Video Wall Functions (Cont.
PAGE 332
Video Wall Functions (Cont.
PAGE 333
Video Wall Functions (Cont.) Name Component setImage(source, pos, size) IWindowComponent IMAGE,,,, Set the image source, position and size relative to the window where is 1 to the maximum source number (see specific module documentation) and and are the window coordinates for the upperleft hand corner of the image and and are the size of the image to be displayed in the window.
PAGE 334
Video Wall Functions (Cont.
PAGE 335
Volume Controller IModuleComponent IModuleComponentListener IVolumeComponent IVolumeControllerComponent IVolumeControllerComponentListener IVolumeComponentListener Name: Volume Controller Interface: IVolumeController Volume Controller Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FW
PAGE 336
Volume Controller Functions (Cont.
PAGE 337
Weather IModuleComponent IModuleComponentListener IWeatherComponent IWeatherComponentListener Name: Weather Interface: IWeather Weather Functions Name Component getDebugState() IModuleComponent ?DEBUG Query the debug level, responds with DEBUG- where is 1-4 for ERROR, WARNING, DEBUG, INFO getFWVersion() IModuleComponent ?FWVERSION Query for the device firmware version, responds with FWVERSION- getProperty(key) IModuleComponent ?PROPERTY- Query for the value of prop
PAGE 338
Weather Functions (Cont.) Name Component processPassbackEvent(byte[]) IModuleComponentListener getChanceOfPrecipitation() IWeatherComponent ?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.
PAGE 339
Weather Functions (Cont.) Name Component getWeatherConditions() IWeatherComponent ?FORECASTCONDITION Query for forecast conditions, responds with FORECASTCONDITION-,, etc.. Value list will contain one forcast condition for each forecast day. The first day is always today.
PAGE 340
Weather Functions (Cont.) Name Component processCurrentConditionEvent(WeatherConditions) IWeatherComponentListener processDewpointEvent(float) IWeatherComponentListener processForecastHighTemperatureEvent(int[]) IWeatherComponentListener FORECASTHIGH-,, etc. Weather forecast high temperatures changes, value list will contain one forcast high temperature for each forecast day. The first day is always today.
PAGE 341
Weather Functions (Cont.
PAGE 342
Weather State Charts processBarometricTrendEvent State Channel 232 STEADY OFF OFF RISING ON OFF FALLING OFF 338 Channel 233 ON Standard NetLinx API (SNAPI) R 1.8.
PAGE 343
Standard NetLinx API (SNAPI): Devices Standard NetLinx API (SNAPI) R 1.7.
PAGE 344
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.