AMX CAFE DUET Instruction Manual Download

Page: 1 / 344

Standard NetLinx API

(SNAPI) R 1.8.0

Devices

instruction manual

last revision: 8-29-06

Document ID: 033-004-2994

Summary of Contents for CAFE DUET

Page 1: ...Standard NetLinx API SNAPI R 1 8 0 Devices instruction manual last revision 8 29 06 Document ID 033 004 2994 ...

Page 2: ... liability applies whether damages are sought or a claim is made under this warranty or as a tort claim including negligence and strict product liability a contract claim or any other claim This limitation of liability cannot be waived or amended by any person This limitation of liability will be effective even if AMX Corporation or an authorized representative of AMX Corporation has been advised ...

Page 3: ...nds and Escape Characters 7 Amplifier 9 Audio Conferencer 13 Audio Mixer 25 Audio Processor 31 Audio Tape 37 Audio Tuner Device 43 Camera 49 Digital Media Decoder 55 Digital Media Encoder 67 Digital Media Server 73 Digital Satellite System 89 Digital Video Recorder 99 Disc Device 113 Document Camera 125 HVAC 131 IO Device 139 Keypad 141 Light 145 Monitor 153 ...

Page 4: ...mp Surround Sound Processor 191 Receiver 203 Relay Device 217 Security System 219 Sensor Device 223 Settop Box 225 Slide Projector 237 Switcher 241 Text Keypad 245 TV 249 Utility 265 VCR 267 Video Conferencer 281 Video Processor 299 Video Projector 311 Video Wall 325 Volume Controller 331 Weather 333 ...

Page 5: ...s Regular virtual devices will not work properly with Duet modules Ports In Duet each device may support one or more ports Multiple ports are used to provide access to different components within the module For instance a switcher may support output volume for each switcher output In Duet this is represented by a volume component for each output and in SNAPI each of these components is mapped to a...

Page 6: ...rete type functions and usually provide discrete feedback For instance channel 255 is the discrete function channel for setPower When turned on this channel sets the state of the power on the device to on When turned off this channel sets the state of the power on the device to off This channel provides discrete feedback as well this channel is on if and only if the state of the power on the devic...

Page 7: ...ommand SNAPI axi SNAPI axi is an include file that defines constants for each channel and level defined by SNAPI These constants can be used in your programs in place of channel and level numbers The constant names are listed in this document alongside every SNAPI function assigned to a channel or level SNAPI axi is located in C Program Files Common Files AMXShare AXIs The file is organized by dev...

Page 8: ...sing the PULSE TO or MIN_TO keywords PULSE dvDevice POWER Cycle the state of power TO dvDevice POWER Cycle the state of power MIN_TO dvDevice POWER Cycle the state of power Discrete function channels are used to activate functions when the channel changes from an OFF state to an ON state and from an ON to an OFF state For instance channel 255 or the constant POWER_ON sets the state of the power on...

Page 9: ... will support ramping natively and that this NetLinx code will not always be required However if the module you are using does not support ramping this code can be used to achieve ramping functionality Levels Levels in SNAPI are used for both function and feedback For feedback levels the level value can be captured in a LEVEL_EVENT with CREATE_LEVEL or sent directly to a touch panel display bargra...

Page 10: ...to the Duet module the behavior of the module is undefined Channel and Level Ranges SNAPI uses only channels in range 1 299 Some channels are used for multiple functions but these channels belong to components that do not overlap within a single device For instance HVAC and Display both use channel 214 for setFanState and setFreezeOn respectively Some channels are used for the same function in mul...

Page 11: ...ackCmdParam Cmd Param DuetPackCmdParamArray Cmd Params DuetPackCmdHeader is a command using a given command header where Hdr is the command header DuetPackCmdParam adds a parameter to the command escaping the parameter and adding parameter separators as needed Cmd is the command to which the parameter is added and Param is the parameter to be added DuetPackCmdParamArray is similar to DuetPackCmdPa...

Page 12: ... 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 cCmdheader DuetParseCmdHeader cTestCmd SWITCH cCmdheader CASE COMMAND cParam1 DuetParseCmdParam cTestCmd cParam2 DuetParseCmdParam cTestCmd cParam3 DuetParseCmdParam cTestCmd cParam4 Duet...

Page 13: ...onent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where s...

Page 14: ...he device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on cycleVolumeMute IVolumeComponent 26 VOL_MUTE Momentary Function Channel Cycle vol ume mute when channel is activated cycleVolumePrese...

Page 15: ...k Channel Volume is muted if channel is on processVolumePresetEvent int IVolumeComponentListener VOLPRESET preset Volume preset changed where preset is 1 x and x is the maximum supported preset see specific module documentation processVolumeRampEvent UP IVolumeComponentListener 24 VOL_UP_FB Feedback Channel Volume is ramping up while channel is on processVolumeRampEvent DOWN IVolumeComponentListen...

Page 16: ...Standard NetLinx API SNAPI R 1 8 0 12 ...

Page 17: ... ACONF_TRAIN Momentary Function Channel Train is exe cuted when the channel is activated processPrivacyEvent boolean IAudioConferencerComponentListener 146 ACONF_PRIVACY_FB Feedback Channel Privacy is muted if channel is on cycleAudibleRing IDialerComponent 205 DIAL_AUDIBLE_RING Momentary Function Channel Cycle audi ble ring when channel is activated cycleAutoAnswer IDialerComponent 204 DIAL_AUTO_...

Page 18: ...nentListener 239 DIAL_AUTO_ANSWER_FB Feedback Channel Auto answer is on if channel is on processDialerStatusEvent BUSY IDialerComponentListener DIALERSTATUS BUSY Dialer status changed number being dialed is busy processDialerStatusEvent CONNECTED IDialerComponentListener DIALERSTATUS CON NECTED Dialer status changed dialer is connected processDialerStatusEvent DIALING IDialerComponentListener DIAL...

Page 19: ... Momentary Function Channel Press menu button DIGIT_1 pressMenuButton DIGIT_2 IMenuComponent 12 DIGIT_2 Momentary Function Channel Press menu button DIGIT_2 pressMenuButton DIGIT_3 IMenuComponent 13 DIGIT_3 Momentary Function Channel Press menu button DIGIT_3 pressMenuButton DIGIT_4 IMenuComponent 14 DIGIT_4 Momentary Function Channel Press menu button DIGIT_4 pressMenuButton DIGIT_5 IMenuComponen...

Page 20: ... LIVE_TV pressMenuButton SLEEP IMenuComponent 63 MENU_SLEEP Momentary Function Channel Press menu button SLEEP pressMenuButton PPV IMenuComponent 64 MENU_PPV Momentary Function Channel Press menu button PPV pressMenuButton FUNCTION IMenuComponent 65 MENU_FUNCTION Momentary Function Channel Press menu button FUNCTION pressMenuButton SETUP IMenuComponent 66 MENU_SETUP Momentary Function Channel Pres...

Page 21: ...y Function Channel Press menu button POUND pressMenuButton COMMA IMenuComponent 94 MENU_COMMA Momentary Function Channel Press menu button COMMA pressMenuButton DIAL IMenuComponent 95 MENU_DIAL Momentary Function Channel Press menu button DIAL pressMenuButton CONFERENCE IMenuComponent 96 MENU_CONFERENCE Momentary Function Channel Press menu button CONFERENCE pressMenuButton PLUS_100 IMenuComponent...

Page 22: ... button HELP pressMenuButton TITLE IMenuComponent 114 MENU_TITLE Momentary Function Channel Press menu button TITLE pressMenuButton TOP_MENU IMenuComponent 115 MENU_TOP_MENU Momentary Function Channel Press menu button TOP_MENU pressMenuButton ZOOM IMenuComponent 116 MENU_ZOOM Momentary Function Channel Press menu button ZOOM pressMenuButton ANGLE IMenuComponent 117 MENU_ANGLE Momentary Function C...

Page 23: ...nuComponent ALPHA P Press menu button P pressMenuButton Q IMenuComponent ALPHA Q Press menu button Q pressMenuButton R IMenuComponent ALPHA R Press menu button R pressMenuButton S IMenuComponent ALPHA S Press menu button S pressMenuButton T IMenuComponent ALPHA T Press menu button T pressMenuButton U IMenuComponent ALPHA U Press menu button U pressMenuButton V IMenuComponent ALPHA V Press menu but...

Page 24: ...t the value of property key to value processDataInitializedEvent boolean IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel Module data is syn chronized with device while channel is on processDebugEvent int IModuleComponentListener DEBUG state Debug state changed where state is 1 4 for ERROR WARNING DEBUG INFO processDeviceOnLineEvent boolean IModuleComponentListener 251 DEVICE_COMMUNI...

Page 25: ...OOKPREV key count position where key is the search key count is the number of records to expect and position is the position of the first record to be returned between 1 through the total number of records queryDB si IPhonebookComponent PHONEBOOKRE FRESH key count Refresh count records starting with the last starting position used with a PHONE BOOKNEXT or PHONEBOOKPREV com mand for the phonebook s...

Page 26: ...honebook search results are available for search with search key key count is the total count of records Use PHONE BOOKNEXT and PHONEBOOKPREV to get more records processStartOfSetEvent String IPhonebookComponentListener PHONEBOOKSTART key Beginning of search set was reached for search with search key key processUpdateRecordEvent boolean String IPhonebookComponentListener PHONEBOOKUP DATE id succes...

Page 27: ...lume preset where preset is 1 to x and x is the maximum supported pre set see specific module documentation setVolumeRamp UP IVolumeComponent 24 VOL_UP Ramping Channel Volume is ramped up while channel is active setVolumeRamp DOWN IVolumeComponent 25 VOL_DN Ramping Channel Volume is ramped down while channel is active processVolumeEvent int IVolumeComponentListener 1 VOL_LVL Volume changed range i...

Page 28: ...Standard NetLinx API SNAPI R 1 8 0 24 ...

Page 29: ...ponds with MIXERPRESET preset where pre set is 1 to x and x is the maximum sup ported preset see specific module documentation isAudioMixerCrosspointMuteOn input output IAudioMixerComponent XPOINTMUTE input output Query for Audio Mixer Crosspoint Mute responds with XPOINTMUTE state input output where state is 0 un muted or 1 muted input is 1 to the maximum supported input and out put is the maximu...

Page 30: ...mum supported input and out put is 1 to the maximum supported output see specific module documentation processAudioMixerPresetEvent int IAudioMixerComponentListener MIXERPRESET pre set Mixer preset changed where preset is 1 to x and x is the maximum supported pre set see specific module documentation cycleGainMute IGainComponent 144 GAIN_MUTE Momentary Function Channel Cycle gain mute when channel...

Page 31: ...eComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back to the NetLinx program as a string from the virtual device setProperty key value IModuleComponent PROPERTY key value Set the value of property key to value processDataInitializedEvent boolean IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel Modul...

Page 32: ...ut output ISwitcherComponent CL sl I input O out put outputÖ Switch input to one or more output s where sl is ALL VIDEO or AUDIO Use input 0 for disconnect switchInputToOutput VIDEO input output ISwitcherComponent VI input O output out put Ö Switch input to one or more output s for switcher level Video Use input 0 for disconnect processSwitcherPresetEvent int ISwitcherComponentListener SWITCHPRESE...

Page 33: ...d down while channel is active processVolumeEvent int IVolumeComponentListener 1 VOL_LVL Volume changed range is 0 255 processVolumeMuteEvent boolean IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel Volume is muted if channel is on processVolumePresetEvent int IVolumeComponentListener VOLPRESET preset Volume preset changed where preset is 1 x and x is the maximum supported preset see spec...

Page 34: ...Standard NetLinx API SNAPI R 1 8 0 30 ...

Page 35: ...OC_PRESET Momentary Function Channel Cycle Audio Processor preset when channel is acti vated cycleAudioProcessorState IAudioProcessorComponent 26 AUDIOPROC_STATE Momentary Function Channel Cycle Audio Processor state when channel is activated getAudioProcessorComponentAd dress index IAudioProcessorComponent AUDIOPROCADDR index Query for the address of the Audio Proces sor object at index index res...

Page 36: ...index where index is 1 through x and x is the maximum supported index see specific module documentation saveAudioProcessorPreset preset IAudioProcessorComponent AUDIOPROCPRESET SAVE preset Save Audio Processor Preset where pre set is 1 to x and x is the maximum sup ported preset see specific module documentation setAudioProcessorCrosspoint input out put value IAudioProcessorComponent XPOINT value ...

Page 37: ...Processor preset changed where preset is 1 to x and x is the maximum supported preset see specific module doc umentation processAudioProcessorStateOnEvent bool ean IAudioProcessorComponentListener 199 AUDIOPROC_STATE_FB Feedback Channel Audio Processor state is on if channel is on processAudioProcessorSwitchEvent int int IAudioProcessorComponentListener SWITCH L sl I input O out put Audio Processo...

Page 38: ...TIN G Feedback Channel Communication is established with device while channel is on processPassbackEvent byte IModuleComponentListener When passback is on each string received form the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device cyclePower IPowerComponent 9 POWER Momentary Function Channel Cycle power when chan...

Page 39: ...35 Standard NetLinx API SNAPI R 1 8 0 Audio Processor State Charts processPowerEvent State Channel 255 OFF OFF ON ON ...

Page 40: ...Standard NetLinx API SNAPI R 1 8 0 36 ...

Page 41: ...channel is active setAudioTapeSide A IAudioTapeComponent 126 CASS_TAPE_SIDE_A Momentary Function Channel Set tape side to side A setAudioTapeSide B IAudioTapeComponent 127 CASS_TAPE_SIDE_B Momentary Function Channel Set tape side to side B processAudioTapeRecordMuteOn Event boolean IAudioTapeComponentListener 200 CASS_RECORD_MUTE_FB Feedback Channel Record mute is on while channel is active proces...

Page 42: ...th device while channel is on processDebugEvent int IModuleComponentListener DEBUG state Debug state changed where state is 1 4 for ERROR WARNING DEBUG INFO processDeviceOnLineEvent boolean IModuleComponentListener 251 DEVICE_COMMUNICATIN G Feedback Channel Communication is established with device while channel is on processPassbackEvent byte IModuleComponentListener When passback is on each strin...

Page 43: ...s set to rewind when the channel is activated setTapeTransport SEARCH_FWD ITapeTransportComponent 6 SFWD Momentary Function Channel Deck is set to search forward when the channel is acti vated setTapeTransport SEARCH_REV ITapeTransportComponent 7 SREV Momentary Function Channel Deck is set to search reverse when the channel is acti vated setTapeTransport RECORD ITapeTransportComponent 8 RECORD Mom...

Page 44: ...hart below processTapeTrans portEvent SEARCH_FWD ITapeTransportComponentListener 246 SFWD_FB Feedback Channel Transport state change see chart below processTapeTransportEvent SEARCH_REV ITapeTransportComponentListener 247 SREV_FB Feedback Channel Transport state change see chart below processTapeTransportEvent RECORD ITapeTransportComponentListener 248 RECORD_FB Feedback Channel Transport state ch...

Page 45: ...F OFF OFF OFF OFF OFF STOP OFF ON OFF OFF OFF OFF OFF OFF OFF OFF PAUSE OFF OFF ON OFF OFF OFF OFF OFF OFF OFF FF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF REW OFF OFF OFF OFF ON OFF OFF OFF OFF OFF SEARCH_FWD OFF OFF OFF OFF OFF ON OFF OFF OFF OFF SEARCH_REV OFF OFF OFF OFF OFF OFF ON OFF OFF OFF RECORD OFF OFF OFF OFF OFF OFF OFF ON OFF OFF RECORD_PAUSE OFF OFF ON OFF OFF OFF OFF ON OFF OFF SLOW_FW...

Page 46: ...Standard NetLinx API SNAPI R 1 8 0 42 ...

Page 47: ...Properties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG st...

Page 48: ...IOChan IPowerComponent IOLINK dps chan nel Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on cycleBand ITunerStationComponent 40 TUNER_BAND Momentary Fu...

Page 49: ...on ITunerStationComponent 235 TUNER_PREV Momentary Function Channel Previous station is selected when channel is acti vated incrementStation ITunerStationComponent 22 CHAN_UP Momentary Function Channel Station is incremented when channel is activated nextStationPreset ITunerStationComponent 225 TUNER_STATION_UP Momentary Function Channel Next station preset is selected when channel is acti vated p...

Page 50: ...essStationPresetPropertiesEv ent String ITunerStationComponentListener STATIONPRESET PROPERTIES index dis playName value i ndex dis playName value Response to STATIONPRESETPROP ERTIES processStationPresetPropertyEvent String ITunerStationComponentListener STATIONPRESET PROPERTY index dis playName value Response to STATIONPRESETPROP ERTY processTunerBandCountEvent count ITunerStationComponentListen...

Page 51: ...Tuner Device Functions Cont Name Component Channel Level Command Constant Notes processTunerComponentProper tyEvent String ITunerStationComponentListener TUNERCOMPONENT PROPERTY index dis playName value Response to TUNERPROPERTY processPowerEvent State Channel 255 OFF OFF ON ON ...

Page 52: ...Standard NetLinx API SNAPI R 1 8 0 48 ...

Page 53: ...CameraPresetProperties ICameraComponent CAMERAPRESET PROPERTIES Query for properties of all camera presets getCameraPresetProperty index ICameraComponent CAMERAPRESET PROPERTY Query for properties of specific camera pre set saveCameraPreset preset ICameraComponent CAMERAPRESET SAVE preset Save Camera Preset where preset is 1 to x and x is the maximum supported pre set see specific module documenta...

Page 54: ... DOWN ICameraComponent 133 TILT_DN Ramping Channel Tilt is ramped down while channel is active setTiltSpeed speed ICameraComponent 30 TILT_SPEED_LVL Set tilt speed range is 0 255 0 slow setZoom zoom ICameraComponent 15 ZOOM_LVL Set zoom position range is 0 255 0 out Wide setZoomRamp OUT ICameraComponent 158 ZOOM_OUT Ramping Channel Zoom is ramped out wide while channel is active setZoomRamp IN ICa...

Page 55: ...vent CLOSE ICameraComponentListener 175 IRIS_CLOSE_FB Feedback Channel Iris is ramping closed while channel is on processIrisSpeedEvent int ICameraComponentListener 20 IRIS_SPEED_LVL Iris speed changed range is 0 255 0 slow processPanEvent int ICameraComponentListener 27 PAN_LVL Pan changed range is 0 255 0 left processPanRampEvent LEFT ICameraComponentListener 134 PAN_LT_FB Feedback Channel Pan i...

Page 56: ...cation with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back t...

Page 57: ... channel is activated setPower ps IPowerComponent 255 POWER_ON Discrete Function Channel Power is on while channel is active setPowerSensor nld nIOChan IPowerComponent IOLINK dps chan nel Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListe...

Page 58: ...Standard NetLinx API SNAPI R 1 8 0 54 ...

Page 59: ...is a String in the format hh mm ss ff queryTrackProperties IDiscTransportComponent TRACKPROPS Query for the track properties responds with multiple TRACKPROP key value commands one for each key queryTrackProperty key IDiscTransportComponent TRACKPROP key Query for a track property responds with TRACKPROP key value command setDiscTransport PLAY IDiscTransportComponent 1 PLAY Momentary Function Chan...

Page 60: ... PLAYPOSITION counter Set the play position where counter is a String in the format hh mm ss ff mm should be 0 mm 60 ss should be 0 ss 60 ff should be valid for the disc type setTrackCounterNotificationOn state IDiscTransportComponent TRACKCOUNTERNO TIFY state Turn track counter notification on or off where state is 1 or 0 processDiscTransportEvent PLAY IDiscTransportComponentListener 241 PLAY_FB ...

Page 61: ...y value queryMediaDeviceProperty sKeyName IMediaDeviceComponent DECODEPROP key Query for one Media Device Properties responds with DECODEPROP key value where key is the property key and value is the property value setMediaDeviceCounterNotificationOn state IMediaDeviceComponent MEDIACOUNTERNO TIFY state Turn media counter notification on or off where state is 1 or 0 setMediaDeviceRandom State RANDO...

Page 62: ...ow processMediaDeviceRepeat StateEvent REPEAT_ALL IMediaDeviceComponentListener 183 MEDIA_REPEAT_ALL_FB Feedback Channel Repeat state change see chart below processMediaDeviceRepeat StateEvent REPEAT_OFF IMediaDeviceComponentListener 184 MEDIA_REPEAT_OFF_FB Feedback Channel Repeat state change see chart below processMediaDeviceSourceInfoEvent Medi aDeviceSourceInfo IMediaDeviceComponentListener DE...

Page 63: ...enu button DIGIT_9 pressMenuButton PLUS_10 IMenuComponent 20 MENU_PLUS_10 Momentary Function Channel Press menu button PLUS_10 pressMenuButton ENTER IMenuComponent 21 MENU_ENTER Momentary Function Channel Press menu button ENTER pressMenuButton CANCEL IMenuComponent 43 MENU_CANCEL Momentary Function Channel Press menu button CANCEL pressMenuButton MENU IMenuComponent 44 MENU_FUNC Momentary Functio...

Page 64: ...ress menu button BACK pressMenuButton FORWARD IMenuComponent 82 MENU_FORWARD Momentary Function Channel Press menu button FORWARD pressMenuButton ADVANCE IMenuComponent 83 MENU_ADVANCE Momentary Function Channel Press menu button ADVANCE pressMenuButton DIMMER IMenuComponent 84 MENU_DIMMER Momentary Function Channel Press menu button DIMMER pressMenuButton HOLD IMenuComponent 85 MENU_HOLD Momentar...

Page 65: ...ion Channel Press menu button INFO pressMenuButton FAVORITES IMenuComponent 102 MENU_FAVORITES Momentary Function Channel Press menu button FAVORITES pressMenuButton CONTINUE IMenuComponent 103 MENU_CONTINUE Momentary Function Channel Press menu button CONTINUE pressMenuButton RETURN IMenuComponent 104 MENU_RETURN Momentary Function Channel Press menu button RETURN pressMenuButton GUIDE IMenuCompo...

Page 66: ...APHICS Momentary Function Channel Press menu button SEND_GRAPHICS pressMenuButton FLASH IMenuComponent 203 MENU_FLASH Momentary Function Channel Press menu button FLASH pressMenuButton RESET IMenuComponent 215 MENU_RESET Momentary Function Channel Press menu button RESET pressMenuButton INSTANT_REPLAY IMenuComponent 218 MENU_INSTANT_REPLAY Momentary Function Channel Press menu button INSTANT_REPLA...

Page 67: ...the debug level responds with DEBUG state where state is 1 4 for ERROR WARNING DEBUG INFO getFWVersion IModuleComponent FWVERSION Query for the device firmware version responds with FWVERSION version getProperty key IModuleComponent PROPERTY key Query for the value of property key respond with PROPERTY key value getVersion IModuleComponent VERSION Query for the module version responds with VERSION...

Page 68: ...er is turned off when channel is activated setPower ps IPowerComponent 255 POWER_ON Discrete Function Channel Power is on while channel is active setPowerSensor nld nIOChan IPowerComponent IOLINK dps chan nel Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON...

Page 69: ...OL_LVL Volume changed range is 0 255 processVolumeMuteEvent boolean IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel Volume is muted if channel is on processVolumePresetEvent int IVolumeComponentListener VOLPRESET preset Volume preset changed where preset is 1 x and x is the maximum supported preset see specific module documentation processVolumeRampEvent UP IVolumeComponentListener 24 VO...

Page 70: ...F 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 OFF OFF OFF OFF OFF ON OFF SLOW_REV OFF OFF OFF OFF OFF OFF OFF ON processMediaDeviceRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON OFF OFF RANDOM_ALL OFF ON OFF RANDOM_OFF OFF OFF ON processMediaDeviceRepeatStateEvent State Channel 181 Channel 182 Channel 1...

Page 71: ...S Query for the track properties responds with multiple TRACKPROP key value commands one for each key queryTrackProperty key IDiscTransportComponent TRACKPROP key Query for a track property responds with TRACKPROP key value command setDiscTransport PLAY IDiscTransportComponent 1 PLAY Momentary Function Channel Deck is set to play when the channel is activated setDiscTransport STOP IDiscTransportCo...

Page 72: ...alid for the disc type setTrackCounterNotificationOn state IDiscTransportComponent TRACKCOUNTERNO TIFY state Turn track counter notification on or off where state is 1 or 0 processDiscTransportEvent PLAY IDiscTransportComponentListener 241 PLAY_FB Feedback Channel Transport state change see chart below processDiscTransportEvent STOP IDiscTransportComponentListener 242 STOP_FB Feedback Channel Tran...

Page 73: ...5 GAIN_LVL Gain changed range is 0 255 processGainMuteEvent boolean IGainComponentListener 143 GAIN_MUTE_FB Feedback Channel Gain is muted if chan nel is on processGainRampEvent UP IGainComponentListener 140 GAIN_UP_FB Feedback Channel Gain is ramping up while channel is on processGainRampEvent DOWN IGainComponentListener 141 GAIN_DN_FB Feedback Channel Gain is ramping down while channel is on get...

Page 74: ... device addOutputStreamSink cURISink IOutputStreamComponent ENCODESINKADD url Add an Output Stream Sink where url is the URL of the sink to be added getOutputStreamSinks IOutputStreamComponent ENCODESINK Query for Output Stream Sinks responds with multiple ENCODESINK url one for each output stream sink where url is the URL of the sink destination getOutputStreamSource IOutputStreamComponent ENCODE...

Page 75: ... IOutputStreamComponentListener ENCODESOURCE url Output Stream Source changed where url is the URL for the source cyclePower IPowerComponent 9 POWER Momentary Function Channel Cycle power when channel is activated setPower ON IPowerComponent 27 PWR_ON Momentary Function Channel Power is turned on when channel is activated setPower OFF IPowerComponent 28 PWR_OFF Momentary Function Channel Power is ...

Page 76: ...0 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 OFF OFF OFF OFF OFF ON OFF SLOW_REV OFF OFF OFF OFF OFF OFF OFF ON processPowerEvent State Channel 255 OFF OFF ON O...

Page 77: ...entary Function Channel Cycles the scan speed when the channel is activated getTrackInfo IDiscTransportComponent TRACKINFO Query for the track info responds with TRACKINFO num duration disc Number where duration is a String in the format hh mm ss ff queryTrackProperties IDiscTransportComponent TRACKPROPS Query for the track properties responds with multiple TRACKPROP key value commands one for eac...

Page 78: ...SLOW_FWD Momentary Function Channel Deck is set to slow forward when the channel is acti vated setDiscTransport SLOW_REV IDiscTransportComponent 189 SLOW_REV Momentary Function Channel Deck is set to slow reverse when the channel is acti vated setPlayPosition mt IDiscTransportComponent PLAYPOSITION counter Set the play position where counter is a String in the format hh mm ss ff mm should be 0 mm ...

Page 79: ...y value commands one for each key cycleGainMute IGainComponent 144 GAIN_MUTE Momentary Function Channel Cycle gain mute when channel is activated setGain level IGainComponent 5 GAIN_LVL Set gain range is 0 255 setGainMuteOn state IGainComponent 143 GAIN_MUTE_ON Discrete Function Channel Gain mute is on while channel is active setGainRamp UP IGainComponent 140 GAIN_UP Ramping Channel Gain is ramped...

Page 80: ...onses with MEDIADBNEXT key count position where key is the search queryDB mdbss IMediaDBComponent MEDIADBPREV key Request previous record count 1 for the media search associated with search key key Responses with MEDIADBPREV key 1 position where key is the search key and position is the position of the first record to be returned between 1 through the total number of records queryDB mdbss count IM...

Page 81: ...y where id is the record ID and key is the 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 is the prop erty value searchDB sr IMediaDBComponent MEDIADBSEARCH key search type search string RETURN retu rn type Search the media database for records with search type equal to sea...

Page 82: ...rned for each key processQueryDBEvent MediaRecord IMediaDBComponentListener MEDIADBRECORD key id name record type url Media record for search with search key key id is the record ID is the record position from 1 to the total number of records name is the item name record type is the record type which could be PICTURE APPLICATION TRACK CHAPTER PLAYLIST BOOK MARK DISC AUDIO VIDEO GENRE ARTIST STATIO...

Page 83: ...nel Repeat track is on while channel is active setMediaDeviceRepeatState REPEAT_ALL IMediaDeviceComponent 183 MEDIA_REPEAT_ALL_ON Momentary Function Channel Repeat all is on while channel is active setMediaDeviceRepeatState REPEAT_OFF IMediaDeviceComponent 184 MEDIA_REPEAT_OFF_ON Momentary Function Channel Repeat off is on while channel is active setMediaDeviceSource cURISource IMediaDeviceCompone...

Page 84: ...nt 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel Move menu cursor UP_RIGHT moveMenuCursor DOWN_LEFT IMenuComponent 53 MENU_DN_LT Momentary Function Channel Move menu cursor DOWN_LEFT moveMenuCursor DOWN_RIGHT IMenuComponent 54 MENU_DN_RT Momentary Function Channel Move menu cursor DOWN_RIGHT pressMe...

Page 85: ...P Momentary Function Channel Press menu button THUMBS_UP pressMenuButton ACCEPT IMenuComponent 60 MENU_ACCEPT Momentary Function Channel Press menu button ACCEPT to answer an incoming call pressMenuButton REJECT IMenuComponent 61 MENU_REJECT Momentary Function Channel Press menu button REJECT to reject an incoming call pressMenuButton LIVE_TV IMenuComponent 62 MENU_LIVE_TV Momentary Function Chann...

Page 86: ...SCORE Momentary Function Channel Press menu button UNDER_SCORE pressMenuButton DASH IMenuComponent 90 MENU_DASH Momentary Function Channel Press menu button DASH pressMenuButton ASTERISK IMenuComponent 91 MENU_ASTERISK Momentary Function Channel Press menu button ASTERISK pressMenuButton DOT IMenuComponent 92 MENU_DOT Momentary Function Channel Press menu button DOT pressMenuButton POUND IMenuComp...

Page 87: ...ry Function Channel Press menu button TV_VCR pressMenuButton RECORD_SPEED IMenuComponent 110 MENU_RECORD_SPEED Momentary Function Channel Press menu button RECORD_SPEED pressMenuButton PROGRAM IMenuComponent 111 MENU_PROGRAM Momentary Function Channel Press menu button PROGRAM pressMenuButton AB_REPEAT IMenuComponent 112 MENU_AB_REPEAT Momentary Function Channel Press menu button AB_REPEAT pressMe...

Page 88: ...t ALPHA G Press menu button G pressMenuButton H IMenuComponent ALPHA H Press menu button H pressMenuButton I IMenuComponent ALPHA I Press menu button I pressMenuButton J IMenuComponent ALPHA J Press menu button J pressMenuButton K IMenuComponent ALPHA K Press menu button K pressMenuButton L IMenuComponent ALPHA L Press menu button L pressMenuButton M IMenuComponent ALPHA M Press menu button M pres...

Page 89: ...bug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back to the NetLinx program as a string from the virtual device setProperty key value IM...

Page 90: ...DEPROP key value Set an Output Stream Property where key is the property key and value is the property value setOutputStreamSource cURISource IOutputStreamComponent ENCODESOURCE url Set Output Stream Source where url is the URL for the source processOutputStreamPropertiesEvent Prop erties IOutputStreamComponentListener ENCODEPROP key value Output Stream Property value where key is the property key...

Page 91: ...e level IVolumeComponent 1 VOL_LVL Set volume range is 0 255 setVolumeMuteOn state IVolumeComponent 199 VOL_MUTE_ON Discrete Function Channel Volume mute is on while channel is active setVolumePreset preset IVolumeComponent VOLPRESET preset Recall volume preset where preset is 1 to x and x is the maximum supported pre set see specific module documentation setVolumeRamp UP IVolumeComponent 24 VOL_U...

Page 92: ... 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 OFF OFF OFF OFF OFF ON OFF SLOW_REV OFF OFF OFF OFF OFF OFF OFF ON processMediaDeviceRandomStateEvent State Channel 178 Channel 179 Channel 180 RANDOM_DISC ON OFF OFF RANDOM_ALL OFF ON OFF RANDOM_OFF OFF OFF ON processMediaDeviceRepeatStateEvent State Channel 181 Channel 182 Channel 18...

Page 93: ...Momentary Function Channel Move menu cursor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel Move menu cursor UP_RIGHT moveMenuCursor DOWN_LEFT IMenuComponent 53 MENU_DN_LT Momentary Function Channel Move menu cursor DOWN_LEFT moveMenuCursor DOWN_RIGHT IMenuC...

Page 94: ...Press menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channel Press menu button EXIT pressMenuButton VIDEO IMenuComponent 57 MENU_VIDEO Momentary Function Channel Press menu button VIDEO pressMenuButton THUMBS_DOWN IMenuComponent 58 MENU_THUMBS_DN Momentary Function Channel Press menu button THUMBS_DOWN pressMenuButton THUMBS_UP IMenuComponent 59 MENU_THUMBS_UP...

Page 95: ...nnel Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Function Channel Press menu button LIST pressMenuButton LEFT_PAREN IMenuComponent 87 MENU_LT_PAREN Momentary Function Channel Press menu button LEFT_PAREN pressMenuButton RIGHT_PAREN IMenuComponent 88 MENU_RT_PAREN Momentary Function Channel Press menu button RIGHT_PAREN pressMenuButton UNDER_SCORE IMenuComponen...

Page 96: ...IDE Momentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuComponent 106 MENU_PAGE_UP Momentary Function Channel Press menu button PAGE_UP pressMenuButton PAGE_DOWN IMenuComponent 107 MENU_PAGE_DN Momentary Function Channel Press menu button PAGE_DOWN pressMenuButton DECK_A_B IMenuComponent 108 MENU_DECK_A_B Momentary Function Channel Press menu button DECK_A_B pressMenuBu...

Page 97: ...STANT_REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu button B pressMenuButton C IMenuComponent ALPHA C Press menu button C pressMenuButton D IMenuComponent ALPHA D Press menu button D pressMenuButton E IMenuComponent ALPHA E Press menu button E pressMenuButton F IMenuComponent ALPHA F Press menu button F pressMenuButton G IMe...

Page 98: ...ROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4...

Page 99: ...stener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on cycleBand ITunerStationComponent 40 TUNER_BAND Momentary Function Channel Cycle tuner band when channel is activated cycleDisplayInfo ITunerStationComponent 234 TUNER_OSD Momentary Function Channel Cycle on screen or front panel display info when channel is activated cycleStationPresetGroup ITunerStationCompon...

Page 100: ...nnel Station is incremented when channel is activated nextStationPreset ITunerStationComponent 225 TUNER_STATION_UP Momentary Function Channel Next station preset is selected when channel is acti vated previousStationPreset ITunerStationComponent 226 TUNER_STATION_DN Momentary Function Channel Previous station preset is selected when channel is activated scanStation FORWARD ITunerStationComponent ...

Page 101: ...ROPERTIES index dis playName value i ndex dis playName value Response to STATIONPRESETPROP ERTIES processStationPresetPropertyEvent String ITunerStationComponentListener STATIONPRESET PROPERTY index dis playName value Response to STATIONPRESETPROP ERTY processTunerBandCountEvent count ITunerStationComponentListener TUNERBANDCOUNT count Response to TUNERBANDCOUNT where count is the integer number o...

Page 102: ...l Satellite System Functions Cont Name Component Channel Level Command Constant Notes processTunerComponentProper tyEvent String ITunerStationComponentListener TUNERCOMPONENT PROPERTY index dis playName value Response to TUNERPROPERTY processPowerEvent State Channel 255 OFF OFF ON ON ...

Page 103: ... duration is a String in the format hh mm ss ff queryTrackProperties IDiscTransportComponent TRACKPROPS Query for the track properties responds with multiple TRACKPROP key value commands one for each key queryTrackProperty key IDiscTransportComponent TRACKPROP key Query for a track property responds with TRACKPROP key value command setDiscTransport PLAY IDiscTransportComponent 1 PLAY Momentary Fun...

Page 104: ...t PLAYPOSITION counter Set the play position where counter is a String in the format hh mm ss ff mm should be 0 mm 60 ss should be 0 ss 60 ff should be valid for the disc type setTrackCounterNotificationOn state IDiscTransportComponent TRACKCOUNTERNO TIFY state Turn track counter notification on or off where state is 1 or 0 processDiscTransportEvent PLAY IDiscTransportComponentListener 241 PLAY_FB...

Page 105: ...ction Channel Move menu cursor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel Move menu cursor UP_RIGHT moveMenuCursor DOWN_LEFT IMenuComponent 53 MENU_DN_LT Momentary Function Channel Move menu cursor DOWN_LEFT moveMenuCursor DOWN_RIGHT IMenuComponent 54 M...

Page 106: ...Function Channel Press menu button THUMBS_DOWN pressMenuButton THUMBS_UP IMenuComponent 59 MENU_THUMBS_UP Momentary Function Channel Press menu button THUMBS_UP pressMenuButton ACCEPT IMenuComponent 60 MENU_ACCEPT Momentary Function Channel Press menu button ACCEPT to answer an incoming call pressMenuButton REJECT IMenuComponent 61 MENU_REJECT Momentary Function Channel Press menu button REJECT to...

Page 107: ...ntary Function Channel Press menu button RIGHT_PAREN pressMenuButton UNDER_SCORE IMenuComponent 89 MENU_UNDERSCORE Momentary Function Channel Press menu button UNDER_SCORE pressMenuButton DASH IMenuComponent 90 MENU_DASH Momentary Function Channel Press menu button DASH pressMenuButton ASTERISK IMenuComponent 91 MENU_ASTERISK Momentary Function Channel Press menu button ASTERISK pressMenuButton DO...

Page 108: ...B Momentary Function Channel Press menu button DECK_A_B pressMenuButton TV_VCR IMenuComponent 109 MENU_TV_VCR Momentary Function Channel Press menu button TV_VCR pressMenuButton RECORD_SPEED IMenuComponent 110 MENU_RECORD_SPEED Momentary Function Channel Press menu button RECORD_SPEED pressMenuButton PROGRAM IMenuComponent 111 MENU_PROGRAM Momentary Function Channel Press menu button PROGRAM press...

Page 109: ...ressMenuButton F IMenuComponent ALPHA F Press menu button F pressMenuButton G IMenuComponent ALPHA G Press menu button G pressMenuButton H IMenuComponent ALPHA H Press menu button H pressMenuButton I IMenuComponent ALPHA I Press menu button I pressMenuButton J IMenuComponent ALPHA J Press menu button J pressMenuButton K IMenuComponent ALPHA K Press menu button K pressMenuButton L IMenuComponent AL...

Page 110: ...ugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back to the NetLinx program as a st...

Page 111: ...Query for currently selected input group getInputProperties ISourceSelectComponent INPUTPROPERTIES Query for the properties of all inputs getInputProperty index ISourceSelectComponent INPUTPROPERTY Query for the properties of a specific input getInputSelect ISourceSelectComponent INPUTSELECT Query for currently selected input getInputSource ISourceSelectComponent INPUT Query current input responds...

Page 112: ...put AUXILIARY 1 when channel is acti vated setInputSource sourceSelect inputNumber ISourceSelectComponent INPUT sourceSe lect inputNumber Set the current input where sourceSe lect is RGB SVIDEO COMPOSITE COM PONENT DVI HDMI SDI VGA AUDIO AUX ILIARY CABLE CAM ERA CD DVD FRONT HDTV LASER DISC LINE MEDIAPLAYER MINIDISC PH ONO SATEL LITE TAPE TUNER TV VCR VIDEO and inputNumber is the instance number o...

Page 113: ...IDEO and inputNumber is the instance number of the source select cycleBand ITunerStationComponent 40 TUNER_BAND Momentary Function Channel Cycle tuner band when channel is activated cycleDisplayInfo ITunerStationComponent 234 TUNER_OSD Momentary Function Channel Cycle on screen or front panel display info when channel is activated cycleStationPresetGroup ITunerStationComponent 224 TUNER_PRESET_GRO...

Page 114: ...nnel Station is incremented when channel is activated nextStationPreset ITunerStationComponent 225 TUNER_STATION_UP Momentary Function Channel Next station preset is selected when channel is acti vated previousStationPreset ITunerStationComponent 226 TUNER_STATION_DN Momentary Function Channel Previous station preset is selected when channel is activated scanStation FORWARD ITunerStationComponent ...

Page 115: ...OPERTIES index dis playName value i ndex dis playName value Response to STATIONPRESETPROP ERTIES processStationPresetPropertyEvent String ITunerStationComponentListener STATIONPRESET PROPERTY index dis playName value Response to STATIONPRESETPROP ERTY processTunerBandCountEvent count ITunerStationComponentListener TUNERBANDCOUNT count Response to TUNERBANDCOUNT where count is the integer number of...

Page 116: ...sDiscTransportEvent 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...

Page 117: ...the disc capacity responds with DISCCAPACITY discs when discs is the number of disc slots supported by the device see specific module documenta tion getDiscInfo IDiscDeviceComponent DISCINFO Query for disc info responds with DIS CINFO num duration of getTitleInfo IDiscDeviceComponent TITLEINFO Query for title info changed responds with TITLEINFO num duration of nextDisc IDiscDeviceComponent 55 DIS...

Page 118: ...rack counter Set the play position where track is the Track number and counter is a String in the format hh mm ss ff mm should be 0 mm 60 ss should be 0 ss 60 ff should be valid for the disc type setRandomState RANDOM_DISC IDiscDeviceComponent 178 DISC_RANDOM_DISC_ON Momentary Function Channel Random disc is on while channel is active setRandomState RANDOM_ALL IDiscDeviceComponent 179 DISC_RANDOM_...

Page 119: ...iscDeviceComponentListener 182 DISC_REPEAT_TRACK_FB Feedback Channel Repeat state change see chart below processRepeatStateEvent REPEAT_ALL IDiscDeviceComponentListener 183 DISC_REPEAT_ALL_FB Feedback Channel Repeat state change see chart below processRepeatStateEvent REPEAT_OFF IDiscDeviceComponentListener 184 DISC_REPEAT_OFF_FB Feedback Channel Repeat state change see chart below processTitleCou...

Page 120: ...he channel is acti vated setDiscTransport RECORD IDiscTransportComponent 8 RECORD Momentary Function Channel Deck is set to record when the channel is activated setDiscTransport FRAME_FWD IDiscTransportComponent 185 FRAME_FWD Momentary Function Channel Deck is set to step frame forward when the channel is activated setDiscTransport FRAME_REV IDiscTransportComponent 186 FRAME_REV Momentary Function...

Page 121: ...ion discNumber Track info changed where num is track number duration is a track duration String in the format hh mm ss ff and dis cNumber is the dusc number the track belongs to processTrackPropertiesEvent Properties IDiscTransportComponentListener TRACKPROP key value Track properties query response responds with multiple TRACKPROP key value commands one for each key moveMenuCursor UP IMenuCompone...

Page 122: ...menu button PLUS_10 pressMenuButton ENTER IMenuComponent 21 MENU_ENTER Momentary Function Channel Press menu button ENTER pressMenuButton CANCEL IMenuComponent 43 MENU_CANCEL Momentary Function Channel Press menu button CANCEL pressMenuButton MENU IMenuComponent 44 MENU_FUNC Momentary Function Channel Press menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channe...

Page 123: ...ess menu button FORWARD pressMenuButton ADVANCE IMenuComponent 83 MENU_ADVANCE Momentary Function Channel Press menu button ADVANCE pressMenuButton DIMMER IMenuComponent 84 MENU_DIMMER Momentary Function Channel Press menu button DIMMER pressMenuButton HOLD IMenuComponent 85 MENU_HOLD Momentary Function Channel Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Funct...

Page 124: ...Function Channel Press menu button FAVORITES pressMenuButton CONTINUE IMenuComponent 103 MENU_CONTINUE Momentary Function Channel Press menu button CONTINUE pressMenuButton RETURN IMenuComponent 104 MENU_RETURN Momentary Function Channel Press menu button RETURN pressMenuButton GUIDE IMenuComponent 105 MENU_GUIDE Momentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuCompo...

Page 125: ...SH Momentary Function Channel Press menu button FLASH pressMenuButton RESET IMenuComponent 215 MENU_RESET Momentary Function Channel Press menu button RESET pressMenuButton INSTANT_REPLAY IMenuComponent 218 MENU_INSTANT_REPLAY Momentary Function Channel Press menu button INSTANT_REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu ...

Page 126: ...rsion getProperty key IModuleComponent PROPERTY key Query for the value of property key respond with PROPERTY key value getVersion IModuleComponent VERSION Query for the module version responds with VERSION version loadProperties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR m...

Page 127: ...re the data from the device cyclePower IPowerComponent 9 POWER Momentary Function Channel Cycle power when channel is activated setPower ON IPowerComponent 27 PWR_ON Momentary Function Channel Power is turned on when channel is activated setPower OFF IPowerComponent 28 PWR_OFF Momentary Function Channel Power is turned off when channel is activated setPower ps IPowerComponent 255 POWER_ON Discrete...

Page 128: ...F 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 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 ...

Page 129: ...ocumentCameraComponent 16 FOCUS_LVL Set focus position range is 0 255 0 near setFocusRamp NEAR IDocumentCameraComponent 160 FOCUS_NEAR Ramping Channel Focus is ramped near while channel is active setFocusRamp FAR IDocumentCameraComponent 161 FOCUS_FAR Ramping Channel Focus is ramped far while channel is active setFocusSpeed speed IDocumentCameraComponent 19 FOCUS_SPEED_LVL Set focus speed range is...

Page 130: ...ner 17 IRIS_LVL Iris changed range is 0 255 0 closed processIrisRampEvent OPEN IDocumentCameraComponentListener 174 IRIS_OPEN_FB Feedback Channel Iris is ramping open while channel is on processIrisRampEvent CLOSE IDocumentCameraComponentListener 175 IRIS_CLOSE_FB Feedback Channel Iris is ramping closed while channel is on processIrisSpeedEvent int IDocumentCameraComponentListener 20 IRIS_SPEED_LV...

Page 131: ...k to the NetLinx program as a string from the virtual device setProperty key value IModuleComponent PROPERTY key value Set the value of property key to value processDataInitializedEvent boolean IModuleComponentListener 252 DATA_INITIALIZED Feedback Channel Module data is syn chronized with device while channel is on processDebugEvent int IModuleComponentListener DEBUG state Debug state changed whe...

Page 132: ... Query current input responds with INPUT sourceSelect inputNumber where sourceSelect is RGB SVIDEO COM POSITE COMPO NENT DVI HDMI SDI VGA AUDIO AUXILI ARY CABLE CAM ERA CD DVD FRONT HDTV LASER DISC LINE MEDIAPLAYER MINIDISC PH ONO SATEL LITE TAPE TUNER TV VCR VIDEO and inputNumber is the instance number of the source select setInputGroupSelect group ISourceSelectComponent INPUTGROUPSE LECT inputGr...

Page 133: ...ount Response to INPUTCOUNT where count is the integer number of inputs processInputGroupSelectEvent group ISourceSelectComponentListener INPUTGROUPSE LECT inputGroup Returns integer index of currently selected input group processInputPropertiesEvent String ISourceSelectComponentListener INPUTPROPERTIES index input Group deviceLa bel signalType AV Type index input Group deviceLa bel signalType AV ...

Page 134: ...urceSelectComponentListener INPUT sourceSe lect inputNumber Current input has changed where source Select is RGB SVIDEO COMPOS ITE COMPONENT DVI HDMI SDI VGA AU DIO AUXILIARY CABLE CAMERA CD COMPUTER DVD FRONT HDTV LASER DISC LINE MEDIAPLAYER MINI DISC PHONO SATELLITE TAPE TUNER TV VCR VIDEO and inputNumber is the instance number of the source select processPowerEvent State Channel 255 OFF OFF ON ...

Page 135: ...ecrement the cool setpoint when channel is activated decrementDehumidifySetpoint IHVACComponent 151 HVAC_DEHUMIDIFY_DN Momentary Function Channel Decrement the dehumidify setpoint when channel is activated decrementHeatSetpoint IHVACComponent 144 HVAC_HEAT_DN Momentary Function Channel Decrement the heat setpoint when channel is activated decrementHumidifySetpoint IHVACComponent 149 HVAC_HUMIDIFY_...

Page 136: ...tpoint setpoint IHVACComponent 31 HVAC_COOL_LVL Set the cool setpoint value is in degrees C or F depending on temperature scale setDehumidifySetpoint setpoint IHVACComponent 38 HVAC_DEHUMIDIFY_LVL Set the dehumidify setpoint value is in per cent setFanState ON IHVACComponent 214 HVAC_FAN_ON Momentary Function Channel Fan state is on while channel is active setFanState AUTO IHVACComponent 215 HVAC_...

Page 137: ...intEvent int IHVACComponentListener 38 HVAC_DEHUMIDIFY_LVL Dehumidify setpoint changed value is in percent processFanStateEvent ON IHVACComponentListener 214 HVAC_FAN_ON_FB Feedback Channel Fan state is on while channel is on processFanStateEvent AUTO IHVACComponentListener 215 HVAC_FAN_AUTO_FB Feedback Channel Fan state is Auto while channel is on processFanStatusEvent PowerState IHVACComponentLi...

Page 138: ...ner 223 HVAC_EHEAT_FB Feedback Channel HVAC state change see chart below processHVACStatusEvent COOL IHVACComponentListener 224 HVAC_COOLING_FB Feedback Channel HVAC status change see chart below processHVACStatusEvent HEAT IHVACComponentListener 225 HVAC_HEATING_FB Feedback Channel HVAC status change see chart below processHVACStatusEvent COOL_2 IHVACComponentListener 226 HVAC_COOLING2_FB Feedbac...

Page 139: ...ate Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back to the NetLinx program as a string from the virtual device setPropert...

Page 140: ... 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 OFF ON processHVACStateEvent State Channel 219 Channel 220 Channel 221 Channel 222 Channel 223 AUTO ON OFF OFF OFF OFF COOL OFF ON OFF OFF OFF HEAT OFF OFF ON OFF OFF OFF OFF OFF OFF ON ...

Page 141: ...NetLinx API SNAPI R 1 8 0 processHVACStatusEvent State Channel 224 Channel 225 Channel 226 Channel 227 OFF OFF OFF OFF OFF COOL ON OFF OFF OFF HEAT OFF ON OFF OFF COOL_2 OFF OFF ON OFF EMERGENCY_HEAT OFF OFF OFF ON ...

Page 142: ...Standard NetLinx API SNAPI R 1 8 0 138 ...

Page 143: ...Sets the I O channel direction where io chan is the integer channel number and io dir is INPUT or OUTPUT setIOChannelInputSense io chan io sense IIODeviceComponent IOCHANNELINPUT SENSE io chan io sense Sets the I O channel input sense where io chan is the integer channel number and io sense is HIGH or LOW setIOChannelState io chan io state IIODeviceComponent IOCHANNELSTATE io chan io state Sets th...

Page 144: ... state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back to the NetLinx program as a string from the virtual device setProp...

Page 145: ... keypad with address key padaddr where keypadaddr is a key pad address removeKeypadComponent index IKeypadComponent KEYPADREMOVEIDX index Remove the keypad at index index where index is 1 x and x is the maximum supported keypad index see specific mod ule documentation setButtonState btnNum bs IKeypadComponent KEYPADBTN btn state Set the state of a keypad button btn for the keypad at index port whe...

Page 146: ...adProperties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG ...

Page 147: ...th a STRING handler to caputre the data from the device processButtonStateEvent State Channel btn RELEASE OFF PUSH ON processButtonStatusEvent State Channel btn Channel btn 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 btn is 1 to 100 the correspond...

Page 148: ...Standard NetLinx API SNAPI R 1 8 0 144 ...

Page 149: ...index keypadaddr removeKeypadComponent keypadAddress IKeypadComponent KEYPA DREMOVEADDR keypadaddr Remove the keypad with address key padaddr where keypadaddr is a key pad address removeKeypadComponent index IKeypadComponent KEYPADREMOVEIDX index Remove the keypad at index index where index is 1 x and x is the maximum supported keypad index see specific mod ule documentation setButtonState btnNum ...

Page 150: ...omponent LIGHTADD index address Add a light at a given index where index is 1 through x and address is a light address and x is the maximum supported light index see specific module documen tation cycleLight index ILightComponent LIGHTSTATE index TOGGLE Cycle the state of a light for the light at index index This command is relevant for light loads and scenes cycleLight 1 ILightComponent LIGHTSTAT...

Page 151: ... of the light at index index responds with LIGHTADDR index address getLightComponentIndex lightAddress ILightComponent LIGHTIDX address Query for the index of the light with address address responds with LIGHTADDR index address getLightLevel index ILightComponent LIGHTLEVEL index Query for the level of a light for the light at index index responds with LIGHT LEVEL index level where level is 0 255 ...

Page 152: ...DDR address Remove the light with address address where address is a light address removeLightComponent index ILightComponent LIGHTREMOVEIDX index Remove the light at index index where index is 1 through x and x is the maxi mum supported light index see specific module documentation setLightLevel index level ILightComponent LIGHTLEVEL index level Set the level of a light for the light at index ind...

Page 153: ... Response to LIGHTSTATE 20 processLightEvent 3 boolean ILightComponentListener LIGHTSTATE 3 state Response to LIGHTSTATE 3 processLightEvent 4 boolean ILightComponentListener LIGHTSTATE 4 state Response to LIGHTSTATE 4 processLightEvent 5 boolean ILightComponentListener LIGHTSTATE 5 state Response to LIGHTSTATE 5 processLightEvent 6 boolean ILightComponentListener LIGHTSTATE 6 state Response to LI...

Page 154: ...boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all response from the device will be passed back to the NetLinx program as a string from the virtual device setProperty key value IModuleComponent PROPERTY key value Set the value of property key to value processDataInitializedEvent boolean IModuleComponentListener 252 DATA_INITIALIZED Feedback...

Page 155: ...el btn Channel btn 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 btn is 1 to 100 the corresponding range for channel btn 100 is 101 to 200 Channels above 200 are passed to the module for advanced processing ...

Page 156: ...Standard NetLinx API SNAPI R 1 8 0 152 ...

Page 157: ...n channel is activated adjustColor 1 IDisplayComponent 151 COLOR_DN Momentary Function Channel Color is decremented when channel is activated adjustContrast 1 IDisplayComponent 152 CONTRAST_UP Momentary Function Channel Contrast is incremented when channel is activated adjustContrast 1 IDisplayComponent 153 CONTRAST_DN Momentary Function Channel Contrast is decremented when channel is activated ad...

Page 158: ...ATIO PROPERTY index Query for specific Aspect Ratio properties getAspectRatioSelect IDisplayComponent ASPECTRATIOSE LECT Query for currently selected Aspect Ratio getVideoType IDisplayComponent VIDEOTYPE Query video type responds with VIDEO TYPE type where type is AUTO NTSC PAL SECAM setActiveWindow mss IDisplayComponent ACTIVEWINDOW mss Set active window where mss is LEFT RIGHT MAIN SUB setAspect...

Page 159: ... name is the display name and value is the ratio processAspectRatioSelectEvent index IDisplayComponentListener ASPECTRATIOSE LECT index Returns integer index of currently selected Aspect Ratio processBrightnessEvent int IDisplayComponentListener 10 BRIGHT_LVL Brightness changed range is 0 255 processColorEvent int IDisplayComponentListener 11 COLOR_LVL Color changed range is 0 255 processContrastE...

Page 160: ...DIGIT_3 Momentary Function Channel Press menu button DIGIT_3 pressMenuButton DIGIT_4 IMenuComponent 14 DIGIT_4 Momentary Function Channel Press menu button DIGIT_4 pressMenuButton DIGIT_5 IMenuComponent 15 DIGIT_5 Momentary Function Channel Press menu button DIGIT_5 pressMenuButton DIGIT_6 IMenuComponent 16 DIGIT_6 Momentary Function Channel Press menu button DIGIT_6 pressMenuButton DIGIT_7 IMenuC...

Page 161: ...PPV pressMenuButton FUNCTION IMenuComponent 65 MENU_FUNCTION Momentary Function Channel Press menu button FUNCTION pressMenuButton SETUP IMenuComponent 66 MENU_SETUP Momentary Function Channel Press menu button SETUP pressMenuButton XM IMenuComponent 77 MENU_XM Momentary Function Channel Press menu button XM pressMenuButton FM IMenuComponent 78 MENU_FM Momentary Function Channel Press menu button ...

Page 162: ...ion Channel Press menu button DIAL pressMenuButton CONFERENCE IMenuComponent 96 MENU_CONFERENCE Momentary Function Channel Press menu button CONFERENCE pressMenuButton PLUS_100 IMenuComponent 97 MENU_PLUS_100 Momentary Function Channel Press menu button PLUS_100 pressMenuButton PLUS_1000 IMenuComponent 98 MENU_PLUS_1000 Momentary Function Channel Press menu button PLUS_1000 pressMenuButton DISPLAY...

Page 163: ...ress menu button TOP_MENU pressMenuButton ZOOM IMenuComponent 116 MENU_ZOOM Momentary Function Channel Press menu button ZOOM pressMenuButton ANGLE IMenuComponent 117 MENU_ANGLE Momentary Function Channel Press menu button ANGLE pressMenuButton AUDIO IMenuComponent 118 MENU_AUDIO Momentary Function Channel Press menu button AUDIO pressMenuButton PREVIEW_INPUT IMenuComponent 129 MENU_PREVIEW_INPUT ...

Page 164: ...nt ALPHA S Press menu button S pressMenuButton T IMenuComponent ALPHA T Press menu button T pressMenuButton U IMenuComponent ALPHA U Press menu button U pressMenuButton V IMenuComponent ALPHA V Press menu button V pressMenuButton W IMenuComponent ALPHA W Press menu button W pressMenuButton X IMenuComponent ALPHA X Press menu button X pressMenuButton Y IMenuComponent ALPHA Y Press menu button Y pre...

Page 165: ...ponentListener 251 DEVICE_COMMUNICATING Feedback Channel Communication is established with device while channel is on processPassbackEvent byte IModuleComponentListener When passback is on each string received form the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device cyclePower IPowerComponent 9 POWER Momentary Func...

Page 166: ...E_TV1 Momentary Function Channel Selects input TV 1 when channel is activated setInputSource VIDEO 1 ISourceSelectComponent 31 SOURCE_VIDEO1 Momentary Function Channel Selects input VIDEO 1 when channel is activated setInputSource VIDEO 2 ISourceSelectComponent 32 SOURCE_VIDEO2 Momentary Function Channel Selects input VIDEO 2 when channel is activated setInputSource VIDEO 3 ISourceSelectComponent ...

Page 167: ... label signalType AVType where group is the integer index based on mutually exclusive inputs label is the text on the device signalType is RGB SVIDEO COMPOSITE COMPO NENT DVI HDMI SDI VGA USB LINELEVE L SPEAKERLEVEL OPTICAL COAXIAL or UNKNOWN and AVType is AUDIO VIDEO ALL processInputPropertyEvent String ISourceSelectComponentListener INPUTPROPERTY index input Group deviceLa bel signalType AV Type...

Page 168: ...reset IVolumeComponent VOLPRESET preset Recall volume preset where preset is 1 to x and x is the maximum supported pre set see specific module documentation setVolumeRamp UP IVolumeComponent 24 VOL_UP Ramping Channel Volume is ramped up while channel is active setVolumeRamp DOWN IVolumeComponent 25 VOL_DN Ramping Channel Volume is ramped down while channel is active processVolumeEvent int IVolumeC...

Page 169: ...RU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the pa...

Page 170: ... Motor direction to close causing motor to move in the CLOSE direction setMotorPosition position IMotorComponent 6 MOTOR_POS_LVL Recall Motor position range is 0 255 0 is close 255 is open setMotorPreset preset IMotorComponent MOTORPRESET pre set Set Motor preset where preset is 1 through x where x is the maximum sup ported preset see specific module docu mentation processMotorDirectionEvent STOP ...

Page 171: ...167 Standard NetLinx API SNAPI R 1 8 0 Motor State Charts processMotorDirectionEvent State Channel 2 Channel 4 Channel 5 STOP ON OFF OFF OPEN OFF ON OFF CLOSE OFF OFF ON ...

Page 172: ...Standard NetLinx API SNAPI R 1 8 0 168 ...

Page 173: ...sor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel Move menu cursor UP_RIGHT moveMenuCursor DOWN_LEFT IMenuComponent 53 MENU_DN_LT Momentary Function Channel Move menu cursor DOWN_LEFT moveMenuCursor DOWN_RIGHT IMenuComponent 54 MENU_DN_RT Momentary Functio...

Page 174: ...menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channel Press menu button EXIT pressMenuButton VIDEO IMenuComponent 57 MENU_VIDEO Momentary Function Channel Press menu button VIDEO pressMenuButton THUMBS_DOWN IMenuComponent 58 MENU_THUMBS_DN Momentary Function Channel Press menu button THUMBS_DOWN pressMenuButton THUMBS_UP IMenuComponent 59 MENU_THUMBS_UP Momen...

Page 175: ...Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Function Channel Press menu button LIST pressMenuButton LEFT_PAREN IMenuComponent 87 MENU_LT_PAREN Momentary Function Channel Press menu button LEFT_PAREN pressMenuButton RIGHT_PAREN IMenuComponent 88 MENU_RT_PAREN Momentary Function Channel Press menu button RIGHT_PAREN pressMenuButton UNDER_SCORE IMenuComponent 89 ...

Page 176: ...omentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuComponent 106 MENU_PAGE_UP Momentary Function Channel Press menu button PAGE_UP pressMenuButton PAGE_DOWN IMenuComponent 107 MENU_PAGE_DN Momentary Function Channel Press menu button PAGE_DOWN pressMenuButton DECK_A_B IMenuComponent 108 MENU_DECK_A_B Momentary Function Channel Press menu button DECK_A_B pressMenuButton ...

Page 177: ..._REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu button B pressMenuButton C IMenuComponent ALPHA C Press menu button C pressMenuButton D IMenuComponent ALPHA D Press menu button D pressMenuButton E IMenuComponent ALPHA E Press menu button E pressMenuButton F IMenuComponent ALPHA F Press menu button F pressMenuButton G IMenuCom...

Page 178: ...TY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ...

Page 179: ...x is the maximum supported preset see specific module documenta tion cyclePower IPowerComponent 9 POWER Momentary Function Channel Cycle power when channel is activated setPower ON IPowerComponent 27 PWR_ON Momentary Function Channel Power is turned on when channel is activated setPower OFF IPowerComponent 28 PWR_OFF Momentary Function Channel Power is turned off when channel is activated setPower...

Page 180: ...ed when channel is activated cycleFreeze IWindowComponent 213 PIC_FREEZE Momentary Function Channel Cycle freeze when channel is activated cyclePictureMute IWindowComponent 210 PIC_MUTE Momentary Function Channel Cycle pic ture mute when channel is activated getImagePosition IWindowComponent IMAGE Query for the image position Response with IMAGE source x y height width where source is 1 to the max...

Page 181: ...move the window with address address where address is a window address removeWindowComponent index IWindowComponent WINDOWRE MOVEIDX index Remove the window at index index where index is 1 through x and x is the maximum supported window index see specific module documentation setBrightness level IWindowComponent 10 BRIGHT_LVL Set brightness level range is 0 255 setColor level IWindowComponent 11 C...

Page 182: ...N Momentary Function Channel Image size is enlarged within the window zoom in tele when channel is activated zoomOut IWindowComponent 158 ZOOM_OUT Momentary Function Channel Image size is reduced within the window zoom out window when channel is activated processBrightnessEvent int IWindowComponentListener 10 BRIGHT_LVL Brightness changed range is 0 255 processColorEvent int IWindowComponentListen...

Page 183: ...dowEvent Position Size IWindowComponentListener WINDOW x y height widt h Window position and or size changed processZOrderEvent int IWindowComponentListener WINDOWZORDER value Z order changed where value is 1 to the maximum z order of the device 1 is the top most z order see specific module doc umentation processPowerEvent State Channel 255 OFF OFF ON ON ...

Page 184: ...Standard NetLinx API SNAPI R 1 8 0 180 ...

Page 185: ...t PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Se...

Page 186: ...cale is FAHRENHEIT CELSIUS incrementPoolSetpoint IPoolSpaComponent 152 POOL_HEAT_UP Momentary Function Channel Pool set point is incremented when channel is acti vated incrementSpaSetpoint IPoolSpaComponent 154 SPA_HEAT_UP Momentary Function Channel Spa set point is incremented when channel is acti vated isPoolSpaAuxOn aux IPoolSpaComponent POOLAUX aux num ber Query for Pool Spa Aux state responds...

Page 187: ...ts LOW IPoolSpaComponent 183 SPA_JETS_LO Momentary Function Channel Set Spa jets to low setSpaJets MEDIUM IPoolSpaComponent 184 SPA_JETS_MED Momentary Function Channel Set Spa jets to medium setSpaJets HIGH IPoolSpaComponent 185 SPA_JETS_HI Momentary Function Channel Set Spa jets to high setSpaLightOn state IPoolSpaComponent 173 SPA_LIGHT_ON Discrete Function Channel Spa light is on while channel ...

Page 188: ...l temperature changed value is in degrees C or F depending on temperature scale processSpaBlowerOnEvent boolean IPoolSpaComponentListener 186 SPA_BLOWER_FB Feedback Channel Spa blower is on while channel is active processSpaHeatStateEvent OFF IPoolSpaComponentListener 178 SPA_HEAT_OFF_FB Feedback Channel Spa heater set to off state see state chart processSpaHeatStateEvent HEATER IPoolSpaComponentL...

Page 189: ...active processSpaPumpOnEvent boolean IPoolSpaComponentListener 171 SPA_PUMP_FB Feedback Channel Spa pump is on while channel is active processSpaSetpointEvent int IPoolSpaComponentListener 40 SPA_HEAT_LVL Spa setpoint changed value is in degrees C or F depending on temperature scale processSpaTemperatureEvent float IPoolSpaComponentListener 42 SPA_TEMP_LVL Spa temperature changed value is in degre...

Page 190: ...N OFF SOLAR_PREFERRED OFF OFF OFF ON processPoolHeatStatusEvent State Channel 187 Channel 188 OFF OFF OFF HEATER ON OFF SOLAR OFF ON processSpaHeatStateEvent State Channel 178 Channel 179 Channel 180 Channel 181 OFF ON OFF OFF OFF HEATER OFF ON OFF OFF SOLAR OFF OFF ON OFF SOLAR_PREFERRED OFF OFF OFF ON processSpaHeatStatusEvent State Channel 189 Channel 190 OFF OFF OFF HEATER ON OFF SOLAR OFF ON ...

Page 191: ...187 Standard NetLinx API SNAPI R 1 8 0 processSpaJetsEvent State Channel 182 Channel 183 Channel 184 Channel 185 OFF ON OFF OFF OFF LOW OFF ON OFF OFF MEDIUM OFF OFF ON OFF HIGH OFF OFF OFF ON ...

Page 192: ...Standard NetLinx API SNAPI R 1 8 0 188 ...

Page 193: ...duleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSB...

Page 194: ...ponent Channel Level Command Constant Notes processPassbackEvent byte IModuleComponentListener When passback is on each string received form the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device ...

Page 195: ...l Move menu cursor DOWN moveMenuCursor LEFT IMenuComponent 47 MENU_LT Momentary Function Channel Move menu cursor LEFT moveMenuCursor RIGHT IMenuComponent 48 MENU_RT Momentary Function Channel Move menu cursor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel ...

Page 196: ... Channel Press menu button ENTER pressMenuButton CANCEL IMenuComponent 43 MENU_CANCEL Momentary Function Channel Press menu button CANCEL pressMenuButton MENU IMenuComponent 44 MENU_FUNC Momentary Function Channel Press menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channel Press menu button EXIT pressMenuButton VIDEO IMenuComponent 57 MENU_VIDEO Momentary Fun...

Page 197: ...Function Channel Press menu button ADVANCE pressMenuButton DIMMER IMenuComponent 84 MENU_DIMMER Momentary Function Channel Press menu button DIMMER pressMenuButton HOLD IMenuComponent 85 MENU_HOLD Momentary Function Channel Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Function Channel Press menu button LIST pressMenuButton LEFT_PAREN IMenuComponent 87 MENU_LT_P...

Page 198: ...U_CONTINUE Momentary Function Channel Press menu button CONTINUE pressMenuButton RETURN IMenuComponent 104 MENU_RETURN Momentary Function Channel Press menu button RETURN pressMenuButton GUIDE IMenuComponent 105 MENU_GUIDE Momentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuComponent 106 MENU_PAGE_UP Momentary Function Channel Press menu button PAGE_UP pressMenuButton P...

Page 199: ...SET IMenuComponent 215 MENU_RESET Momentary Function Channel Press menu button RESET pressMenuButton INSTANT_REPLAY IMenuComponent 218 MENU_INSTANT_REPLAY Momentary Function Channel Press menu button INSTANT_REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu button B pressMenuButton C IMenuComponent ALPHA C Press menu button C pr...

Page 200: ...y IModuleComponent PROPERTY key Query for the value of property key respond with PROPERTY key value getVersion IModuleComponent VERSION Query for the module version responds with VERSION version loadProperties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buff...

Page 201: ... channel is active setPowerSensor nld nIOChan IPowerComponent IOLINK dps chan nel Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on adjustBalance 1 IPre...

Page 202: ...rocessLoudnessEvent boolean IPreAmpComponentListener 207 LOUDNESS_FB Feedback Channel Loudness is on if chan nel is on processSurroundModeEvent SurroundMode IPreAmpComponentListener SURROUND mode Surround mode changed where mode is MUSIC MOVIE OFF processTrebleEvent int IPreAmpComponentListener 4 TREBLE_LVL Treble changed range is 0 255 cycleInputSource ISourceSelectComponent 196 SOURCE_CYCLE Mome...

Page 203: ...ion Channel Selects input TAPE 2 when channel is activated setInputSource CD 1 ISourceSelectComponent 36 SOURCE_CD1 Momentary Function Channel Selects input CD 1 when channel is activated setInputSource TUNER 1 ISourceSelectComponent 37 SOURCE_TUNER1 Momentary Function Channel Selects input TUNER 1 when channel is activated setInputSource PHONO 1 ISourceSelectComponent 38 SOURCE_PHONO1 Momentary F...

Page 204: ...KNOWN and AVType is AUDIO VIDEO ALL processInputSelectEvent index ISourceSelectComponentListener INPUTSELECT index Returns integer index of currently selected input processInputSourceEvent InputSourceSe lectInfo ISourceSelectComponentListener INPUT sourceSe lect inputNumber Current input has changed where source Select is RGB SVIDEO COMPOS ITE COMPONENT DVI HDMI SDI VGA AU DIO AUXILIARY CABLE CAME...

Page 205: ... is ramped down while channel is active processVolumeEvent int IVolumeComponentListener 1 VOL_LVL Volume changed range is 0 255 processVolumeMuteEvent boolean IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel Volume is muted if channel is on processVolumePresetEvent int IVolumeComponentListener VOLPRESET preset Volume preset changed where preset is 1 x and x is the maximum supported preset...

Page 206: ...Standard NetLinx API SNAPI R 1 8 0 202 ...

Page 207: ...nction Channel Move menu cursor DOWN moveMenuCursor LEFT IMenuComponent 47 MENU_LT Momentary Function Channel Move menu cursor LEFT moveMenuCursor RIGHT IMenuComponent 48 MENU_RT Momentary Function Channel Move menu cursor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Func...

Page 208: ...nu button PLUS_10 pressMenuButton ENTER IMenuComponent 21 MENU_ENTER Momentary Function Channel Press menu button ENTER pressMenuButton CANCEL IMenuComponent 43 MENU_CANCEL Momentary Function Channel Press menu button CANCEL pressMenuButton MENU IMenuComponent 44 MENU_FUNC Momentary Function Channel Press menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channel ...

Page 209: ...s menu button FORWARD pressMenuButton ADVANCE IMenuComponent 83 MENU_ADVANCE Momentary Function Channel Press menu button ADVANCE pressMenuButton DIMMER IMenuComponent 84 MENU_DIMMER Momentary Function Channel Press menu button DIMMER pressMenuButton HOLD IMenuComponent 85 MENU_HOLD Momentary Function Channel Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Functio...

Page 210: ...nction Channel Press menu button FAVORITES pressMenuButton CONTINUE IMenuComponent 103 MENU_CONTINUE Momentary Function Channel Press menu button CONTINUE pressMenuButton RETURN IMenuComponent 104 MENU_RETURN Momentary Function Channel Press menu button RETURN pressMenuButton GUIDE IMenuComponent 105 MENU_GUIDE Momentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuCompone...

Page 211: ... Momentary Function Channel Press menu button FLASH pressMenuButton RESET IMenuComponent 215 MENU_RESET Momentary Function Channel Press menu button RESET pressMenuButton INSTANT_REPLAY IMenuComponent 218 MENU_INSTANT_REPLAY Momentary Function Channel Press menu button INSTANT_REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu bu...

Page 212: ...ion getProperty key IModuleComponent PROPERTY key Query for the value of property key respond with PROPERTY key value getVersion IModuleComponent VERSION Query for the module version responds with VERSION version loadProperties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR mod...

Page 213: ...active setPowerSensor nld nIOChan IPowerComponent IOLINK dps chan nel Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on adjustBalance 1 IPreAmpComponent...

Page 214: ...ssEvent boolean IPreAmpComponentListener 207 LOUDNESS_FB Feedback Channel Loudness is on if chan nel is on processSurroundModeEvent SurroundMode IPreAmpComponentListener SURROUND mode Surround mode changed where mode is MUSIC MOVIE OFF processTrebleEvent int IPreAmpComponentListener 4 TREBLE_LVL Treble changed range is 0 255 cycleInputSource ISourceSelectComponent 196 SOURCE_CYCLE Momentary Functi...

Page 215: ...Selects input TAPE 2 when channel is activated setInputSource CD 1 ISourceSelectComponent 36 SOURCE_CD1 Momentary Function Channel Selects input CD 1 when channel is activated setInputSource TUNER 1 ISourceSelectComponent 37 SOURCE_TUNER1 Momentary Function Channel Selects input TUNER 1 when channel is activated setInputSource PHONO 1 ISourceSelectComponent 38 SOURCE_PHONO1 Momentary Function Chan...

Page 216: ...AVType is AUDIO VIDEO ALL processInputSelectEvent index ISourceSelectComponentListener INPUTSELECT index Returns integer index of currently selected input processInputSourceEvent InputSourceSe lectInfo ISourceSelectComponentListener INPUT sourceSe lect inputNumber Current input has changed where source Select is RGB SVIDEO COMPOS ITE COMPONENT DVI HDMI SDI VGA AU DIO AUXILIARY CABLE CAMERA CD COMP...

Page 217: ... ITunerStationComponent TUNERCOMPO NENTPROPERTIES Query for properties of all tuner compo nents getTunerComponentProperty index ITunerStationComponent TUNERCOMPO NENTPROPERTY index Query for properties of specific tuner com ponent gotoPreviousStation ITunerStationComponent 235 TUNER_PREV Momentary Function Channel Previous station is selected when channel is acti vated incrementStation ITunerStati...

Page 218: ...STATIONPRESET COUNT count Response to TUNERCOUNT where count is the integer number of tuner components processStationPresetEvent int ITunerStationComponentListener TUNERPRESET int Tuner preset changed where preset is 1 x and x is the maximum supported preset see specific module documentation processStationPresetPropertiesEv ent String ITunerStationComponentListener STATIONPRESET PROPERTIES index d...

Page 219: ...um supported preset see specific module documentation setVolume level IVolumeComponent 1 VOL_LVL Set volume range is 0 255 setVolumeMuteOn state IVolumeComponent 199 VOL_MUTE_ON Discrete Function Channel Volume mute is on while channel is active setVolumePreset preset IVolumeComponent VOLPRESET preset Recall volume preset where preset is 1 to x and x is the maximum supported pre set see specific m...

Page 220: ...Standard NetLinx API SNAPI R 1 8 0 216 Receiver State Charts processPowerEvent State Channel 255 OFF OFF ON ON ...

Page 221: ...duleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSB...

Page 222: ...an IRelayDeviceComponent RELAYCHANNEL STATE rly chan Query for the relay channel state where rly chan is the integer channel number responds with RELAYCHANNELCOUNT setRelayChannelState rly chan rly state IRelayDeviceComponent RELAYCHANNEL STATE rly chan rly state Sets the relay channel state where rly chan is the integer channel number and rly state is ON or OFF processRelayChannelCountEvent count...

Page 223: ...uffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleCompon...

Page 224: ...with SECSTATE state where state is ARM_HOME ARM ARM_HOME_NOW ARM_NOW DISARM FIRE PANIC POLICE MEDICAL or NONE getSecurityStatus ISecuritySystemComponent SECSTATUS Query for Security Status responds with SECSTATUS status where status is DISARMED ARMED_HOME ARMED ALARM isOKToArm ISecuritySystemComponent SECARMABLE Query for Security arm able status responds with SECARMABLE status where status is 1 o...

Page 225: ...rityPointSta tus ISecuritySystemComponentListener SECPOINTSTATUS point status Point Status changed where point is 1 to the maximum point point as returned by getPointCount see specific module docu mentation and status is ACTIVE FAULT or BYPASSED processSecurityStateEvent SecurityState ISecuritySystemComponentListener SECSTATE state Security State changed where state is ARM_HOME ARM ARM_HOME_NOW AR...

Page 226: ...Standard NetLinx API SNAPI R 1 8 0 222 ...

Page 227: ...eComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK...

Page 228: ...NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device processSensorStateEvent ON ISensorComponentListener 255 SENSOR_FB Feedback Channel Sensor state changed sensor is on while channel is on processSensorValueEvent int ISensorComponentListener 7 SENSOR_VALUE Value of the sensor changed range is spe cific to the sensor tpe v see specific mod u...

Page 229: ...RIGHT IMenuComponent 48 MENU_RT Momentary Function Channel Move menu cursor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel Move menu cursor UP_RIGHT moveMenuCursor DOWN_LEFT IMenuComponent 53 MENU_DN_LT Momentary Function Channel Move menu cursor DOWN_LEFT ...

Page 230: ... menu button CANCEL pressMenuButton MENU IMenuComponent 44 MENU_FUNC Momentary Function Channel Press menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channel Press menu button EXIT pressMenuButton VIDEO IMenuComponent 57 MENU_VIDEO Momentary Function Channel Press menu button VIDEO pressMenuButton THUMBS_DOWN IMenuComponent 58 MENU_THUMBS_DN Momentary Function ...

Page 231: ...hannel Press menu button DIMMER pressMenuButton HOLD IMenuComponent 85 MENU_HOLD Momentary Function Channel Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Function Channel Press menu button LIST pressMenuButton LEFT_PAREN IMenuComponent 87 MENU_LT_PAREN Momentary Function Channel Press menu button LEFT_PAREN pressMenuButton RIGHT_PAREN IMenuComponent 88 MENU_RT_P...

Page 232: ...N Momentary Function Channel Press menu button RETURN pressMenuButton GUIDE IMenuComponent 105 MENU_GUIDE Momentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuComponent 106 MENU_PAGE_UP Momentary Function Channel Press menu button PAGE_UP pressMenuButton PAGE_DOWN IMenuComponent 107 MENU_PAGE_DN Momentary Function Channel Press menu button PAGE_DOWN pressMenuButton DECK_...

Page 233: ...nt 218 MENU_INSTANT_REPLAY Momentary Function Channel Press menu button INSTANT_REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu button B pressMenuButton C IMenuComponent ALPHA C Press menu button C pressMenuButton D IMenuComponent ALPHA D Press menu button D pressMenuButton E IMenuComponent ALPHA E Press menu button E pressMen...

Page 234: ...me IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug...

Page 235: ...back Channel Power state changed power is on while channel is on cycleABSwitch ISettopBoxComponent 42 CABLE_AB Momentary Function Channel Cycle AB switch when channel is activated setBSwitchOn state ISettopBoxComponent 212 CABLE_B_ON Discrete Function Channel AB switch set to B when channel is active processBSwitchEvent boolean ISettopBoxComponentListener 212 CABLE_B_FB Feedback Channel AB switch ...

Page 236: ...tationComponent TUNERCOMPO NENTPROPERTY index Query for properties of specific tuner com ponent gotoPreviousStation ITunerStationComponent 235 TUNER_PREV Momentary Function Channel Previous station is selected when channel is acti vated incrementStation ITunerStationComponent 22 CHAN_UP Momentary Function Channel Station is incremented when channel is activated nextStationPreset ITunerStationCompo...

Page 237: ...mponentListener TUNERPRESET int Tuner preset changed where preset is 1 x and x is the maximum supported preset see specific module documentation processStationPresetPropertiesEv ent String ITunerStationComponentListener STATIONPRESET PROPERTIES index dis playName value i ndex dis playName value Response to STATIONPRESETPROPER TIES processStationPresetPropertyEvent String ITunerStationComponentList...

Page 238: ...ent 1 VOL_LVL Set volume range is 0 255 setVolumeMuteOn state IVolumeComponent 199 VOL_MUTE_ON Discrete Function Channel Volume mute is on while channel is active setVolumePreset preset IVolumeComponent VOLPRESET preset Recall volume preset where preset is 1 to x and x is the maximum supported pre set see specific module documentation setVolumeRamp UP IVolumeComponent 24 VOL_UP Ramping Channel Vol...

Page 239: ...235 Standard NetLinx API SNAPI R 1 8 0 Settop Box State Charts processPowerEvent State Channel 255 OFF OFF ON ON ...

Page 240: ...Standard NetLinx API SNAPI R 1 8 0 236 ...

Page 241: ...RNOTIFY state Turn counter notification on or off where state is 1 or 0 setLampPower ON ILampComponent 27 PWR_ON Momentary Function Channel Lamp power is turned on when channel is activated setLampPower OFF ILampComponent 28 PWR_OFF Momentary Function Channel Lamp power is turned off when channel is activated setLampPower ps ILampComponent 255 POWER_ON Discrete Function Channel Lamp power is on wh...

Page 242: ...oduleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set the passback state where state is 1 or 0 When passback is on all resp...

Page 243: ...ng Channel Focus is ramped near while channel is active setFocusRamp FAR ISlideProjectorComponent 161 FOCUS_FAR Ramping Channel Focus is ramped far while channel is active setSlide int ISlideProjectorComponent SLIDE slide Set Slide where slide is 1 to x where x is the maximum support slide see specific module documentation processFocusRampEvent NEAR ISlideProjectorComponentListener 160 FOCUS_NEAR_...

Page 244: ...Standard NetLinx API SNAPI R 1 8 0 240 ...

Page 245: ...entListener 5 GAIN_LVL Gain changed range is 0 255 processGainMuteEvent boolean IGainComponentListener 143 GAIN_MUTE_FB Feedback Channel Gain is muted if chan nel is on processGainRampEvent UP IGainComponentListener 140 GAIN_UP_FB Feedback Channel Gain is ramping up while channel is on processGainRampEvent DOWN IGainComponentListener 141 GAIN_DN_FB Feedback Channel Gain is ramping down while chann...

Page 246: ...omponentListener 251 DEVICE_COMMUNICATING Feedback Channel Communication is established with device while channel is on processPassbackEvent byte IModuleComponentListener When passback is on each string received form the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device getInput sl output ISwitcherComponent INPUT sl ...

Page 247: ..._MUTE Momentary Function Channel Cycle vol ume mute when channel is activated cycleVolumePreset IVolumeComponent 138 VOL_PRESET Momentary Function Channel Cycle cam era preset when channel is activated getVolumePreset IVolumeComponent VOLPRESET Query for volume preset responds with VOLPRESET preset saveVolumePreset preset IVolumeComponent VOLPRESETSAVE preset Save Volume Preset where preset is 1 t...

Page 248: ...annel Level Command 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 ...

Page 249: ... with KEYPADADDR index keypadaddr removeKeypadComponent keypadAddress IKeypadComponent KEYPA DREMOVEADDR keypadaddr Remove the keypad with address key padaddr where keypadaddr is a key pad address removeKeypadComponent index IKeypadComponent KEYPADREMOVEIDX index Remove the keypad at index index where index is 1 x and x is the maximum supported keypad index see specific mod ule documentation setBu...

Page 250: ...nds with FWVERSION version getProperty key IModuleComponent PROPERTY key Query for the value of property key respond with PROPERTY key value getVersion IModuleComponent VERSION Query for the module version responds with VERSION version loadProperties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules i...

Page 251: ...ere see specific mod ule documentation setText line column text ITextKeypadComponent TEXT line col umn text Set text starting at a given line and column Characters will be overwritten as needed based on text Text will not wrap around to the next line setTextDisplay text ITextKeypadComponent TEXT text Set text starting at line 1 and column 1 Text will wrap around to the next line to fill the displa...

Page 252: ...Standard NetLinx API SNAPI R 1 8 0 248 ...

Page 253: ...yComponent 150 COLOR_UP Momentary Function Channel Color is incremented when channel is activated adjustColor 1 IDisplayComponent 151 COLOR_DN Momentary Function Channel Color is decremented when channel is activated adjustContrast 1 IDisplayComponent 152 CONTRAST_UP Momentary Function Channel Contrast is incremented when channel is activated adjustContrast 1 IDisplayComponent 153 CONTRAST_DN Mome...

Page 254: ...RatioProperties index IDisplayComponent ASPECTRATIO PROPERTIES Query for all Aspect Ratio properties getAspectRatioProperty index IDisplayComponent ASPECTRATIO PROPERTY index Query for specific Aspect Ratio properties getAspectRatioSelect IDisplayComponent ASPECTRATIOSE LECT Query for currently selected Aspect Ratio getVideoType IDisplayComponent VIDEOTYPE Query video type responds with VIDEO TYPE...

Page 255: ...e display name and value is the ratio processAspectRatioPropertyEvent String IDisplayComponentListener ASPECTRATIOPROP ERTY index dis playName value Response to ASPECTRATIOPROP ERTY where name is the display name and value is the ratio processAspectRatioSelectEvent index IDisplayComponentListener ASPECTRATIOSE LECT index Returns integer index of currently selected Aspect Ratio processBrightnessEve...

Page 256: ...ary Function Channel Press menu button DIGIT_1 pressMenuButton DIGIT_2 IMenuComponent 12 DIGIT_2 Momentary Function Channel Press menu button DIGIT_2 pressMenuButton DIGIT_3 IMenuComponent 13 DIGIT_3 Momentary Function Channel Press menu button DIGIT_3 pressMenuButton DIGIT_4 IMenuComponent 14 DIGIT_4 Momentary Function Channel Press menu button DIGIT_4 pressMenuButton DIGIT_5 IMenuComponent 15 DI...

Page 257: ...V pressMenuButton SLEEP IMenuComponent 63 MENU_SLEEP Momentary Function Channel Press menu button SLEEP pressMenuButton PPV IMenuComponent 64 MENU_PPV Momentary Function Channel Press menu button PPV pressMenuButton FUNCTION IMenuComponent 65 MENU_FUNCTION Momentary Function Channel Press menu button FUNCTION pressMenuButton SETUP IMenuComponent 66 MENU_SETUP Momentary Function Channel Press menu ...

Page 258: ...ion Channel Press menu button POUND pressMenuButton COMMA IMenuComponent 94 MENU_COMMA Momentary Function Channel Press menu button COMMA pressMenuButton DIAL IMenuComponent 95 MENU_DIAL Momentary Function Channel Press menu button DIAL pressMenuButton CONFERENCE IMenuComponent 96 MENU_CONFERENCE Momentary Function Channel Press menu button CONFERENCE pressMenuButton PLUS_100 IMenuComponent 97 MEN...

Page 259: ... HELP pressMenuButton TITLE IMenuComponent 114 MENU_TITLE Momentary Function Channel Press menu button TITLE pressMenuButton TOP_MENU IMenuComponent 115 MENU_TOP_MENU Momentary Function Channel Press menu button TOP_MENU pressMenuButton ZOOM IMenuComponent 116 MENU_ZOOM Momentary Function Channel Press menu button ZOOM pressMenuButton ANGLE IMenuComponent 117 MENU_ANGLE Momentary Function Channel ...

Page 260: ...nent ALPHA P Press menu button P pressMenuButton Q IMenuComponent ALPHA Q Press menu button Q pressMenuButton R IMenuComponent ALPHA R Press menu button R pressMenuButton S IMenuComponent ALPHA S Press menu button S pressMenuButton T IMenuComponent ALPHA T Press menu button T pressMenuButton U IMenuComponent ALPHA U Press menu button U pressMenuButton V IMenuComponent ALPHA V Press menu button V p...

Page 261: ...device while channel is on processDebugEvent int IModuleComponentListener DEBUG state Debug state changed where state is 1 4 for ERROR WARNING DEBUG INFO processDeviceOnLineEvent boolean IModuleComponentListener 251 DEVICE_COMMUNICATING Feedback Channel Communication is established with device while channel is on processPassbackEvent byte IModuleComponentListener When passback is on each string re...

Page 262: ...ECT inputGroup Set input group selection setInputSelect index ISourceSelectComponent INPUTSELECT index Set input selection setInputSource TV 1 ISourceSelectComponent 30 SOURCE_TV1 Momentary Function Channel Selects input TV 1 when channel is activated setInputSource VIDEO 1 ISourceSelectComponent 31 SOURCE_VIDEO1 Momentary Function Channel Selects input VIDEO 1 when channel is activated setInputSo...

Page 263: ...d input group processInputPropertiesEvent String ISourceSelectComponentListener INPUTPROPERTIES index input Group deviceLa bel signalType AV Type index input Group deviceLa bel signalType AV Type Response to INPUTPROPERTIES index group label signal Type AVType index group label signalType AVType where group is the integer index based on mutually exclusive inputs label is the text on the device sig...

Page 264: ...tationComponent BAND Query for band responds with BAND tb where tb is AM FM FM_MONO SATELLITE_RADIO L ONG_WAVE MEDIUM_WAVE SHORT_W AVE TV getStation ITunerStationComponent XCH Query for station responds with XCH sta tion where station is a station string such as 501 103 7 or 5 1 getStationPreset ITunerStationComponent TUNERPRESET Query for tuner preset responds with TUNERPRESET preset getStationPr...

Page 265: ...229 TUNER_SEEK_FWD Momentary Function Channel Seeks for next station while channel is activate seekStation BACKWARD ITunerStationComponent 230 TUNER_SEEK_REV Momentary Function Channel Seeks for previous station while channel is activate setBand tb ITunerStationComponent BAND tb Set band where tb is AM FM FM_MONO SATELLITE_RADIO L ONG_WAVE MEDIUM_WAVE SHORT_W AVE TV setStation station ITunerStatio...

Page 266: ... d Response to TUNERBANDPROPERTY processTunerComponentCountEvent count ITunerStationComponentListener TUNERCOMPONENT COUNT Response to TUNERCOUNT where count is the integer number of tuner components processTunerComponentPropertiesEv ent String ITunerStationComponentListener TUNERCOMPONENT PROPERTIES index dis playName value index dis playName value Response to TUNERPROPERTIES processTunerComponen...

Page 267: ...25 VOL_DN Ramping Channel Volume is ramped down while channel is active processVolumeEvent int IVolumeComponentListener 1 VOL_LVL Volume changed range is 0 255 processVolumeMuteEvent boolean IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel Volume is muted if channel is on processVolumePresetEvent int IVolumeComponentListener VOLPRESET preset Volume preset changed where preset is 1 x and x...

Page 268: ...Standard NetLinx API SNAPI R 1 8 0 264 ...

Page 269: ...PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set ...

Page 270: ...nent Channel Level Command Constant Notes processPassbackEvent byte IModuleComponentListener When passback is on each string received form the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device ...

Page 271: ...T Momentary Function Channel Move menu cursor LEFT moveMenuCursor RIGHT IMenuComponent 48 MENU_RT Momentary Function Channel Move menu cursor RIGHT moveMenuCursor UP_LEFT IMenuComponent 51 MENU_UP_LT Momentary Function Channel Move menu cursor UP_LEFT moveMenuCursor UP_RIGHT IMenuComponent 52 MENU_UP_RT Momentary Function Channel Move menu cursor UP_RIGHT moveMenuCursor DOWN_LEFT IMenuComponent 53...

Page 272: ...menu button ENTER pressMenuButton CANCEL IMenuComponent 43 MENU_CANCEL Momentary Function Channel Press menu button CANCEL pressMenuButton MENU IMenuComponent 44 MENU_FUNC Momentary Function Channel Press menu button MENU pressMenuButton EXIT IMenuComponent 50 MENU_EXIT Momentary Function Channel Press menu button EXIT pressMenuButton VIDEO IMenuComponent 57 MENU_VIDEO Momentary Function Channel P...

Page 273: ...el Press menu button ADVANCE pressMenuButton DIMMER IMenuComponent 84 MENU_DIMMER Momentary Function Channel Press menu button DIMMER pressMenuButton HOLD IMenuComponent 85 MENU_HOLD Momentary Function Channel Press menu button HOLD pressMenuButton LIST IMenuComponent 86 MENU_LIST Momentary Function Channel Press menu button LIST pressMenuButton LEFT_PAREN IMenuComponent 87 MENU_LT_PAREN Momentary...

Page 274: ...ntary Function Channel Press menu button CONTINUE pressMenuButton RETURN IMenuComponent 104 MENU_RETURN Momentary Function Channel Press menu button RETURN pressMenuButton GUIDE IMenuComponent 105 MENU_GUIDE Momentary Function Channel Press menu button GUIDE pressMenuButton PAGE_UP IMenuComponent 106 MENU_PAGE_UP Momentary Function Channel Press menu button PAGE_UP pressMenuButton PAGE_DOWN IMenuC...

Page 275: ...nent 215 MENU_RESET Momentary Function Channel Press menu button RESET pressMenuButton INSTANT_REPLAY IMenuComponent 218 MENU_INSTANT_REPLAY Momentary Function Channel Press menu button INSTANT_REPLAY pressMenuButton A IMenuComponent ALPHA A Press menu button A pressMenuButton B IMenuComponent ALPHA B Press menu button B pressMenuButton C IMenuComponent ALPHA C Press menu button C pressMenuButton ...

Page 276: ...ent PROPERTY key Query for the value of property key respond with PROPERTY key value getVersion IModuleComponent VERSION Query for the module version responds with VERSION version loadProperties fileName IModuleComponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleCompo...

Page 277: ...omponent IOLINK dps chan nel Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on cycleInputSource ISourceSelectComponent 196 SOURCE_CYCLE Momentary Functi...

Page 278: ...lects input TAPE 2 when channel is activated setInputSource CD 1 ISourceSelectComponent 36 SOURCE_CD1 Momentary Function Channel Selects input CD 1 when channel is activated setInputSource TUNER 1 ISourceSelectComponent 37 SOURCE_TUNER1 Momentary Function Channel Selects input TUNER 1 when channel is activated setInputSource PHONO 1 ISourceSelectComponent 38 SOURCE_PHONO1 Momentary Function Channe...

Page 279: ... Returns integer index of currently selected input processInputSourceEvent InputSourceSe lectInfo ISourceSelectComponentListener INPUT sourceSe lect inputNumber Current input has changed where source Select is RGB SVIDEO COMPOS ITE COMPONENT DVI HDMI SDI VGA AU DIO AUXILIARY CABLE CAMERA CD COMPUTER DVD FRONT HDTV LASER DISC LINE MEDIAPLAYER MINI DISC PHONO SATELLITE TAPE TUNER T V VCR VIDEO and i...

Page 280: ... boolean ITapeTransportComponentListener 122 TAPE_LOADED_FB Feedback Channel Tape is loaded while channel is on processTapeRecordLockedEvent boolean ITapeTransportComponentListener 123 RECORD_LOCK_FB Feedback Channel Tape is record locked while channel is on processTapeTransportEvent PLAY ITapeTransportComponentListener 241 PLAY_FB Feedback Channel Transport state change see chart below processTap...

Page 281: ... 7 or 5 1 getStationPreset ITunerStationComponent TUNERPRESET Query for tuner preset responds with TUNERPRESET preset getStationPresetCount ITunerStationComponent STATIONPRESET COUNT Query for number of station presets getStationPresetProperties ITunerStationComponent STATIONPRESET PROPERTIES Query for properties of all station presets getStationPresetProperty index ITunerStationComponent STATIONP...

Page 282: ...tivate setBand tb ITunerStationComponent BAND tb Set band where tb is AM FM FM_MONO SATELLITE_RADIO L ONG_WAVE MEDIUM_WAVE SHORT_W AVE TV setStation station ITunerStationComponent XCH station Set station where station is a station string such as 501 103 7 or 5 1 setStationPreset preset ITunerStationComponent TUNERPRESET pre set Recall tuner preset where preset is 1 x and x is the maximum supported...

Page 283: ...s playName tunerBan d index dis playName tuner Band Response to TUNERBANDPROPERTIES processTunerBandPropertyEvent String ITunerStationComponentListener TUNERBANDPROP ERTY index dis playName tunerBan d Response to TUNERBANDPROPERTY processTunerComponentCountEvent count ITunerStationComponentListener TUNERCOMPONENT COUNT Response to TUNERCOUNT where count is the integer number of tuner components pr...

Page 284: ...FF OFF OFF OFF OFF STOP OFF ON OFF OFF OFF OFF OFF OFF OFF OFF PAUSE OFF OFF ON OFF OFF OFF OFF OFF OFF OFF FF OFF OFF OFF ON OFF OFF OFF OFF OFF OFF REW OFF OFF OFF OFF ON OFF OFF OFF OFF OFF SEARCH_FWD OFF OFF OFF OFF OFF ON OFF OFF OFF OFF SEARCH_REV OFF OFF OFF OFF OFF OFF ON OFF OFF OFF RECORD OFF OFF OFF OFF OFF OFF OFF ON OFF OFF RECORD_PAUSE OFF OFF ON OFF OFF OFF OFF ON OFF OFF SLOW_FWD O...

Page 285: ...s ICameraComponent 173 AUTO_IRIS Momentary Function Channel Cycle auto iris when channel is activated cycleCameraPreset ICameraComponent 177 CAM_PRESET Momentary Function Channel Cycle cam era preset when channel is activated getCameraComponentCount ICameraComponent CAMERACOMPO NENTCOUNT Query for number of camera components getCameraPreset ICameraComponent CAMERAPRESET Query for camera preset res...

Page 286: ...mp CLOSE ICameraComponent 175 IRIS_CLOSE Ramping Channel Iris is ramped closed while channel is active setIrisSpeed speed ICameraComponent 20 IRIS_SPEED_LVL Set iris speed range is 0 255 0 slow setPan pan ICameraComponent 27 PAN_LVL Set pan position range is 0 255 0 left setPanRamp LEFT ICameraComponent 134 PAN_LT Ramping Channel Pan is ramped left while channel is active setPanRamp RIGHT ICameraC...

Page 287: ...tListener CAMERAPRESET PROPERTY index dis playName value Response to CAMERAPRESETPROP ERTY processFocusEvent int ICameraComponentListener 16 FOCUS_LVL Focus changed range is 0 255 0 near processFocusRampEvent NEAR ICameraComponentListener 160 FOCUS_NEAR_FB Feedback Channel Focus is ramping near while channel is on processFocusRampEvent FAR ICameraComponentListener 161 FOCUS_FAR_FB Feedback Channel...

Page 288: ...eed changed range is 0 255 0 slow cycleAudibleRing IDialerComponent 205 DIAL_AUDIBLE_RING Momentary Function Channel Cycle audi ble ring when channel is activated cycleAutoAnswer IDialerComponent 204 DIAL_AUTO_ANSWER Momentary Function Channel Cycle auto answer when channel is activated cycleOffHook IDialerComponent 202 DIAL_OFF_HOOK Momentary Function Channel Cycle hook state when channel is acti...

Page 289: ...ialerComponentListener DIALERSTATUS DIS CONNECTED Dialer status changed dialer is discon nected idel processDialerStatusEvent FAULT IDialerComponentListener DIALERSTATUS FAULT Dialer status changed dialer encounter a fault during dialing negotiating processDialerStatusEvent NEGOTIATING IDialerComponentListener DIALERSTATUS NEGOTIATING Dialer status changed dialer is negotiating processDialerStatus...

Page 290: ...6 Momentary Function Channel Press menu button DIGIT_6 pressMenuButton DIGIT_7 IMenuComponent 17 DIGIT_7 Momentary Function Channel Press menu button DIGIT_7 pressMenuButton DIGIT_8 IMenuComponent 18 DIGIT_8 Momentary Function Channel Press menu button DIGIT_8 pressMenuButton DIGIT_9 IMenuComponent 19 DIGIT_9 Momentary Function Channel Press menu button DIGIT_9 pressMenuButton PLUS_10 IMenuCompone...

Page 291: ...ponent 78 MENU_FM Momentary Function Channel Press menu button FM pressMenuButton AM IMenuComponent 79 MENU_AM Momentary Function Channel Press menu button AM pressMenuButton CLEAR IMenuComponent 80 MENU_CLEAR Momentary Function Channel Press menu button CLEAR pressMenuButton BACK IMenuComponent 81 MENU_BACK Momentary Function Channel Press menu button BACK pressMenuButton FORWARD IMenuComponent 8...

Page 292: ...tion Channel Press menu button PLUS_1000 pressMenuButton DISPLAY IMenuComponent 99 MENU_DISPLAY Momentary Function Channel Press menu button DISPLAY pressMenuButton SUBTITLE IMenuComponent 100 MENU_SUBTITLE Momentary Function Channel Press menu button SUBTITLE pressMenuButton INFO IMenuComponent 101 MENU_INFO Momentary Function Channel Press menu button INFO pressMenuButton FAVORITES IMenuComponen...

Page 293: ... menu button AUDIO pressMenuButton PREVIEW_INPUT IMenuComponent 129 MENU_PREVIEW_INPUT Momentary Function Channel Press menu button PREVIEW_INPUT pressMenuButton SEND_INPUT IMenuComponent 130 MENU_SEND_INPUT Momentary Function Channel Press menu button SEND_INPUT pressMenuButton SEND_GRAPHICS IMenuComponent 131 MENU_SEND_GRAPHICS Momentary Function Channel Press menu button SEND_GRAPHICS pressMenu...

Page 294: ... pressMenuButton Y IMenuComponent ALPHA Y Press menu button Y pressMenuButton Z IMenuComponent ALPHA Z Press menu button Z selectMenuItem IMenuComponent 49 MENU_SELECT Momentary Function Channel Select cur rent menu item getDebugState IModuleComponent DEBUG Query the debug level responds with DEBUG state where state is 1 4 for ERROR WARNING DEBUG INFO getFWVersion IModuleComponent FWVERSION Query ...

Page 295: ...the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device closeSearchDB searchHandle IPhonebookComponent PHONEBOOKCLOS ESEARCH key Close the search associated with search key key deleteRecord recordID IPhonebookComponent PHONEBOOKDE LETE id Delete phonebook record with index id of id getPhonebookCapacity IPhonebookCompon...

Page 296: ...t record to be returned between 1 through the total number of records searchDB sr IPhonebookComponent PHONEBOOK SEARCH key ID id Search the phonebook database for records with ID equal to id If id is all records are returned key is a search key used in other search operations such as closeSearchDB It can be any string you like such as a panel device number or internal key that makes sense for your...

Page 297: ...activated setPower ON IPowerComponent 27 PWR_ON Momentary Function Channel Power is turned on when channel is activated setPower OFF IPowerComponent 28 PWR_OFF Momentary Function Channel Power is turned off when channel is activated setPower ps IPowerComponent 255 POWER_ON Discrete Function Channel Power is on while channel is active setPowerSensor nld nIOChan IPowerComponent IOLINK dps chan nel A...

Page 298: ...when channel is activated setInputSource VIDEO 2 ISourceSelectComponent 32 SOURCE_VIDEO2 Momentary Function Channel Selects input VIDEO 2 when channel is activated setInputSource VIDEO 3 ISourceSelectComponent 33 SOURCE_VIDEO3 Momentary Function Channel Selects input VIDEO 3 when channel is activated setInputSource TAPE 1 ISourceSelectComponent 34 SOURCE_TAPE1 Momentary Function Channel Selects in...

Page 299: ...group label signalType AVType where group is the integer index based on mutually exclusive inputs label is the text on the device signalType is RGB SVIDEO COMPOSITE COMPO NENT DVI HDMI SDI VGA USB LINELEVE L SPEAKERLEVEL OPTICAL COAXIAL or UNKNOWN and AVType is AUDIO VIDEO ALL processInputPropertyEvent String ISourceSelectComponentListener INPUTPROPERTY index input Group deviceLa bel signalType AV...

Page 300: ...CY_FB Feedback Channel Privacy is muted if channel is on cycleVolumeMute IVolumeComponent 26 VOL_MUTE Momentary Function Channel Cycle vol ume mute when channel is activated cycleVolumePreset IVolumeComponent 138 VOL_PRESET Momentary Function Channel Cycle cam era preset when channel is activated getVolumePreset IVolumeComponent VOLPRESET Query for volume preset responds with VOLPRESET preset save...

Page 301: ... preset Volume preset changed where preset is 1 x and x is the maximum supported preset see specific module documentation 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 processPowerEvent State Channe...

Page 302: ...Standard NetLinx API SNAPI R 1 8 0 298 ...

Page 303: ... 151 COLOR_DN Momentary Function Channel Color is decremented when channel is activated adjustContrast 1 IDisplayComponent 152 CONTRAST_UP Momentary Function Channel Contrast is incremented when channel is activated adjustContrast 1 IDisplayComponent 153 CONTRAST_DN Momentary Function Channel Contrast is decremented when channel is activated adjustSharpness 1 IDisplayComponent 154 SHARP_UP Momenta...

Page 304: ...playComponent ASPECTRATIOSE LECT Query for currently selected Aspect Ratio getVideoType IDisplayComponent VIDEOTYPE Query video type responds with VIDEO TYPE type where type is AUTO NTSC PAL SECAM setActiveWindow mss IDisplayComponent ACTIVEWINDOW mss Set active window where mss is LEFT RIGHT MAIN SUB setAspectRatio aspectRatio IDisplayComponent ASPECT aspectRa tio Set aspect ratio where aspectRat...

Page 305: ...ue is the ratio processAspectRatioSelectEvent index IDisplayComponentListener ASPECTRATIOSE LECT index Returns integer index of currently selected Aspect Ratio processBrightnessEvent int IDisplayComponentListener 10 BRIGHT_LVL Brightness changed range is 0 255 processColorEvent int IDisplayComponentListener 11 COLOR_LVL Color changed range is 0 255 processContrastEvent int IDisplayComponentListene...

Page 306: ... 13 DIGIT_3 Momentary Function Channel Press menu button DIGIT_3 pressMenuButton DIGIT_4 IMenuComponent 14 DIGIT_4 Momentary Function Channel Press menu button DIGIT_4 pressMenuButton DIGIT_5 IMenuComponent 15 DIGIT_5 Momentary Function Channel Press menu button DIGIT_5 pressMenuButton DIGIT_6 IMenuComponent 16 DIGIT_6 Momentary Function Channel Press menu button DIGIT_6 pressMenuButton DIGIT_7 IM...

Page 307: ...ton PPV pressMenuButton FUNCTION IMenuComponent 65 MENU_FUNCTION Momentary Function Channel Press menu button FUNCTION pressMenuButton SETUP IMenuComponent 66 MENU_SETUP Momentary Function Channel Press menu button SETUP pressMenuButton XM IMenuComponent 77 MENU_XM Momentary Function Channel Press menu button XM pressMenuButton FM IMenuComponent 78 MENU_FM Momentary Function Channel Press menu but...

Page 308: ...unction Channel Press menu button DIAL pressMenuButton CONFERENCE IMenuComponent 96 MENU_CONFERENCE Momentary Function Channel Press menu button CONFERENCE pressMenuButton PLUS_100 IMenuComponent 97 MENU_PLUS_100 Momentary Function Channel Press menu button PLUS_100 pressMenuButton PLUS_1000 IMenuComponent 98 MENU_PLUS_1000 Momentary Function Channel Press menu button PLUS_1000 pressMenuButton DIS...

Page 309: ...el Press menu button TOP_MENU pressMenuButton ZOOM IMenuComponent 116 MENU_ZOOM Momentary Function Channel Press menu button ZOOM pressMenuButton ANGLE IMenuComponent 117 MENU_ANGLE Momentary Function Channel Press menu button ANGLE pressMenuButton AUDIO IMenuComponent 118 MENU_AUDIO Momentary Function Channel Press menu button AUDIO pressMenuButton PREVIEW_INPUT IMenuComponent 129 MENU_PREVIEW_IN...

Page 310: ...ponent ALPHA S Press menu button S pressMenuButton T IMenuComponent ALPHA T Press menu button T pressMenuButton U IMenuComponent ALPHA U Press menu button U pressMenuButton V IMenuComponent ALPHA V Press menu button V pressMenuButton W IMenuComponent ALPHA W Press menu button W pressMenuButton X IMenuComponent ALPHA X Press menu button X pressMenuButton Y IMenuComponent ALPHA Y Press menu button Y...

Page 311: ...eComponentListener 251 DEVICE_COMMUNICATING Feedback Channel Communication is established with device while channel is on processPassbackEvent byte IModuleComponentListener When passback is on each string received form the device is sent to the NetLinx pro gram as a string Use a DATA_EVENT event with a STRING handler to caputre the data from the device cyclePower IPowerComponent 9 POWER Momentary ...

Page 312: ...OURCE_TV1 Momentary Function Channel Selects input TV 1 when channel is activated setInputSource VIDEO 1 ISourceSelectComponent 31 SOURCE_VIDEO1 Momentary Function Channel Selects input VIDEO 1 when channel is activated setInputSource VIDEO 2 ISourceSelectComponent 32 SOURCE_VIDEO2 Momentary Function Channel Selects input VIDEO 2 when channel is activated setInputSource VIDEO 3 ISourceSelectCompon...

Page 313: ...roup label signalType AVType where group is the integer index based on mutually exclusive inputs label is the text on the device signalType is RGB SVIDEO COMPOSITE COMPO NENT DVI HDMI SDI VGA USB LINELEVE L SPEAKERLEVEL OPTICAL COAXIAL or UNKNOWN and AVType is AUDIO VIDEO ALL processInputPropertyEvent String ISourceSelectComponentListener INPUTPROPERTY index input Group deviceLa bel signalType AV ...

Page 314: ...PresetNum IVideoProcessorComponent VPROCPRESET SAVE preset Save video processor Preset where pre set is 1 to x and x is the maximum sup ported preset see specific module documentation setVideoProcessorPreset nPresetNum IVideoProcessorComponent VPROCPRESET pre set Recall video processor preset where pre set is 1 to x and x is the maximum sup ported preset see specific module documentation processVi...

Page 315: ...lor is incremented when channel is activated adjustColor 1 IDisplayComponent 151 COLOR_DN Momentary Function Channel Color is decremented when channel is activated adjustContrast 1 IDisplayComponent 152 CONTRAST_UP Momentary Function Channel Contrast is incremented when channel is activated adjustContrast 1 IDisplayComponent 153 CONTRAST_DN Momentary Function Channel Contrast is decremented when c...

Page 316: ...ECTRATIO PROPERTY index Query for specific Aspect Ratio properties getAspectRatioSelect IDisplayComponent ASPECTRATIOSE LECT Query for currently selected Aspect Ratio getVideoType IDisplayComponent VIDEOTYPE Query video type responds with VIDEO TYPE type where type is AUTO NTSC PAL SECAM setActiveWindow mss IDisplayComponent ACTIVEWINDOW mss Set active window where mss is LEFT RIGHT MAIN SUB setAs...

Page 317: ...se to ASPECTRATIOPROP ERTY where name is the display name and value is the ratio processAspectRatioSelectEvent index IDisplayComponentListener ASPECTRATIOSE LECT index Returns integer index of currently selected Aspect Ratio processBrightnessEvent int IDisplayComponentListener 10 BRIGHT_LVL Brightness changed range is 0 255 processColorEvent int IDisplayComponentListener 11 COLOR_LVL Color changed...

Page 318: ...wnCounterEvent int ILampComponentListener COOLING time Cool down counter time time is seconds remaining processLampPowerEvent WARMING_UP ILampComponentListener 253 LAMP_WARMING_FB Feedback Channel Indicates Lamp is warming and cannot accept commands processLampPower Event COOLING_DOWN ILampComponentListener 254 LAMP_COOLING_FB Feedback Channel Indicates Lamp is cool ing and cannot accept commands ...

Page 319: ... Momentary Function Channel Press menu button DIGIT_6 pressMenuButton DIGIT_7 IMenuComponent 17 DIGIT_7 Momentary Function Channel Press menu button DIGIT_7 pressMenuButton DIGIT_8 IMenuComponent 18 DIGIT_8 Momentary Function Channel Press menu button DIGIT_8 pressMenuButton DIGIT_9 IMenuComponent 19 DIGIT_9 Momentary Function Channel Press menu button DIGIT_9 pressMenuButton PLUS_10 IMenuComponen...

Page 320: ...onent 78 MENU_FM Momentary Function Channel Press menu button FM pressMenuButton AM IMenuComponent 79 MENU_AM Momentary Function Channel Press menu button AM pressMenuButton CLEAR IMenuComponent 80 MENU_CLEAR Momentary Function Channel Press menu button CLEAR pressMenuButton BACK IMenuComponent 81 MENU_BACK Momentary Function Channel Press menu button BACK pressMenuButton FORWARD IMenuComponent 82...

Page 321: ...ion Channel Press menu button PLUS_1000 pressMenuButton DISPLAY IMenuComponent 99 MENU_DISPLAY Momentary Function Channel Press menu button DISPLAY pressMenuButton SUBTITLE IMenuComponent 100 MENU_SUBTITLE Momentary Function Channel Press menu button SUBTITLE pressMenuButton INFO IMenuComponent 101 MENU_INFO Momentary Function Channel Press menu button INFO pressMenuButton FAVORITES IMenuComponent...

Page 322: ...menu button AUDIO pressMenuButton PREVIEW_INPUT IMenuComponent 129 MENU_PREVIEW_INPUT Momentary Function Channel Press menu button PREVIEW_INPUT pressMenuButton SEND_INPUT IMenuComponent 130 MENU_SEND_INPUT Momentary Function Channel Press menu button SEND_INPUT pressMenuButton SEND_GRAPHICS IMenuComponent 131 MENU_SEND_GRAPHICS Momentary Function Channel Press menu button SEND_GRAPHICS pressMenuB...

Page 323: ...pressMenuButton Y IMenuComponent ALPHA Y Press menu button Y pressMenuButton Z IMenuComponent ALPHA Z Press menu button Z selectMenuItem IMenuComponent 49 MENU_SELECT Momentary Function Channel Select cur rent menu item getDebugState IModuleComponent DEBUG Query the debug level responds with DEBUG state where state is 1 4 for ERROR WARNING DEBUG INFO getFWVersion IModuleComponent FWVERSION Query f...

Page 324: ...he data from the device cycleInputSource ISourceSelectComponent 196 SOURCE_CYCLE Momentary Function Channel Cycle input source when channel is activated getInputCount ISourceSelectComponent INPUTCOUNT Query for the number of inputs getInputGroupSelect ISourceSelectComponent INPUTGROUPSE LECT Query for currently selected input group getInputProperties ISourceSelectComponent INPUTPROPERTIES Query fo...

Page 325: ...HONO 1 when channel is activated setInputSource AUXILIARY 1 ISourceSelectComponent 39 SOURCE_AUX1 Momentary Function Channel Selects input AUXILIARY 1 when channel is acti vated setInputSource sourceSelect inputNumber ISourceSelectComponent INPUT sourceSe lect inputNumber Set the current input where sourceSe lect is RGB SVIDEO COMPOSITE COM PONENT DVI HDMI SDI VGA AUDIO AUXI LIARY CABLE CAM ERA CD...

Page 326: ... VPROJPRESET Query for projector preset responds with VPROJPRESET preset setProjectorPreset preset IVideoProjectorComponent VPROJPRESET pre set Recall projector preset where preset is 1 x and x is the maximum supported preset see specific module documentation processProjectorPresetEvent int IVideoProjectorComponentListener VPROJPRESET int Projector preset changed where preset is 1 x and x is the m...

Page 327: ... processVolumeMuteEvent boolean IVolumeComponentListener 199 VOL_MUTE_FB Feedback Channel Volume is muted if channel is on processVolumePresetEvent int IVolumeComponentListener VOLPRESET preset Volume preset changed where preset is 1 x and x is the maximum supported preset see specific module documentation processVolumeRampEvent UP IVolumeComponentListener 24 VOL_UP_FB Feedback Channel Volume is r...

Page 328: ...Standard NetLinx API SNAPI R 1 8 0 324 ...

Page 329: ...omponent LOADPROPERTY file Load properties from the file with the sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state wher...

Page 330: ...Associate a Power Sensor with the device where dps is the DPS in string form i e 17 1 0 and channel is the channel on the IO device to which the power sensor is connected processPowerEvent ON IPowerComponentListener 255 POWER_FB Feedback Channel Power state changed power is on while channel is on getVideoWallConfiguration IVideoWallComponent VWALLCONFIG Query for video wall configuration responds ...

Page 331: ...l is activated adjustSharpness 1 IWindowComponent 154 SHARP_UP Momentary Function Channel Sharpness is incremented when channel is activated adjustSharpness 1 IWindowComponent 155 SHARP_DN Momentary Function Channel Sharpness is decremented when channel is activated adjustTint 1 IWindowComponent 156 TINT_UP Momentary Function Channel Tint is incre mented when channel is activated adjustTint 1 IWin...

Page 332: ...ow when channel is activated pan DOWN IWindowComponent 133 PAN_DN Momentary Function Channel Image is moved down one step within the window when channel is activated pan LEFT IWindowComponent 134 PAN_LT Momentary Function Channel Image is moved left one step within the window when channel is activated pan RIGHT IWindowComponent 135 PAN_RT Momentary Function Channel Image is moved right one step wi...

Page 333: ...e to the display where x and y are the dis play coordinates for the upper left hand corner of the window and height and width are the size of the window to be displayed in the display Used to change the position of the window visible in the dis play setZOrder position IWindowComponent WINDOWZORDER position Shuffle the window z order relative to the other windows where postiion is FRONT BACK FORWAR...

Page 334: ... specific module docu mentation processPictureMuteEvent boolean IWindowComponentListener 211 PIC_MUTE_FB Feedback Channel Picture is muted if channel is on processSharpnessEvent int IWindowComponentListener 13 SHARP_LVL Sharpness changed range is 0 255 processTintEvent int IWindowComponentListener 14 TINT_LVL Tint changed range is 0 255 processWindowEvent Position Size IWindowComponentListener WIN...

Page 335: ...he sup plied filename Used to load meta data properties for modules including Generic IR modules passThru buffer IModuleComponent PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime d...

Page 336: ...tation setVolume level IVolumeComponent 1 VOL_LVL Set volume range is 0 255 setVolumeMuteOn state IVolumeComponent 199 VOL_MUTE_ON Discrete Function Channel Volume mute is on while channel is active setVolumePreset preset IVolumeComponent VOLPRESET preset Recall volume preset where preset is 1 to x and x is the maximum supported pre set see specific module documentation setVolumeRamp UP IVolumeCom...

Page 337: ...PASSTHRU buffer Send a message directly to the device reinitialize IModuleComponent REINIT Reinitialize communication with the device setDebugState state IModuleComponent DEBUG state Set the debug state where state is 1 4 for ERROR WARNING DEBUG INFO setDeviceDateTime date IModuleComponent CLOCK mm dd yyyy hh mm ss Set the device date time setPassbackOn boolean IModuleComponent PASSBACK state Set ...

Page 338: ...LYCLOUDY RAIN RAINSHOWERS RAINSNOWMIX SLEET SMOKE SNOW SNOWFLURRIES SNOWSHOWERS SUNNY THUNDERSTORMS UNKNOWN VERYCOLD WINDY getForecastHighTemperature IWeatherComponent FORECASTHIGH Query for forecast high temperatures changes responds with FORECASTHIGH day 1 day 2 etc Value list will con tain one forcast high temperature for each forecast day The first day is always today Values are in degrees C o...

Page 339: ...nding on scale and direction will be N NNE NE ENE E ESE SE SSE S SSW SW WSW W WNW NW NNW queryWeatherAll IWeatherComponent 208 WEATHER_FORCE_READI NG Momentary Function Channel Causes the weather station to update its readings when the channel is activated setWeatherScale us IWeatherComponent WEATHERSCALE scale Set the weather scale where scale is IMPERIAL or METRIC processBarometricPressureEvent ...

Page 340: ...ecast day The first day is always today Values are in degrees C or F depending on weather scale processHeatIndexEvent float IWeatherComponentListener 46 WEATHER_HEAT_INDEX_L VL Heat index temperature changed value is in degrees C or F depending on weather scale processHighTemperatureEvent float IWeatherComponentListener 43 WEATHER_HI_TEMP_LVL High temperature since midnight changed value is in deg...

Page 341: ...ns IWeatherComponentListener FORECASTCONDI TION day 1 day 2 etc Weather forecast conditions changed value list will contain one forcast condition for each forecast day The first day is always today Values will be BLIZZARD BLOWINGSNOW CLEAR CLOUDY DRIZZLE DUST FAIR FOG FREEZ INGDRIZZLE FREEZINGRAIN HAZE HUMID ICE MOSTLYCLOUDY MOSTLYSUNNY PARTLYCLOUDY RAIN RAINSHOWERS RAINSNOWMIX SLEET SMOKE SNOW SN...

Page 342: ...Standard NetLinx API SNAPI R 1 8 0 338 Weather State Charts processBarometricTrendEvent State Channel 232 Channel 233 STEADY OFF OFF RISING ON OFF FALLING OFF ON ...

Page 343: ...Standard NetLinx API SNAPI Devices 339 Standard NetLinx API SNAPI R 1 7 0 ...

Page 344: ...IL 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 ATLANTA BOSTON CHICAGO CLEVELAND DALLAS DENVER INDIANAPOLIS LOS ANGELES MINNEAPOLIS PHILADELPHIA PHOENIX PORTLAND SPOKANE TAMPA 3000 RESEARCH DRIVE RICHARDSON TX 75082 USA 800 222 0193 469 624...

Search results

Summary of Contents for CAFE DUET

Reviews:

Related manuals for CAFE DUET

Brands by name

Popular brands

AMX CAFE DUET, Instruction Manual

Search results

Summary of Contents for CAFE DUET

Reviews:

Related manuals for CAFE DUET

Brands by name

Popular brands