User manual AMX CAFE DUET STANDARD NETLINX API (SNAPI) DEVICES

[. . . ] instruction manual Standard NetLinx API (SNAPI) R 1. 8. 0 Devices last revision: 8-29-06 Document ID: 033-004-2994 AMX Limited Warranty and Disclaimer AMX Corporation warrants its products to be free of defects in material and workmanship under normal use for three (3) years from the date of purchase from AMX Corporation, with the following exceptions: · · · · · Electroluminescent and LCD Control Panels are warranted for three (3) years, except for the display and touch overlay components that are warranted for a period of one (1) year. Disk drive mechanisms, pan/tilt heads, power supplies, MX Series products, and KC Series products are warranted for a period of one (1) year. Unless otherwise specified, OEM and custom products are warranted for a period of one (1) year. Batteries and incandescent lamps are not covered under the warranty. This warranty extends only to products purchased directly from AMX Corporation or an Authorized AMX Dealer. [. . . ] <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, BOOKMARK, DISC, AUDIO, VIDEO, GENRE, ARTIST, STATION and <url> is the URL of the media. Media search results are available for search with search key <key>. Beginning of search set was reached for search with search key <key> Media record with record id of <id> was updated if <success> is 1, otherwise update failed. MEDIA_RANDOM MEDIA_REPEAT ?DECODESOURCE Momentary Function Channel: Cycle random when channel is activated Momentary Function Channel: Cycle repeat when channel is activated Query for Media Device Source, responds with DECODESOURCE-<url> where <url> is the URL of the source. processCloseEvent(String) IMediaDBComponentListener MEDIADBCLOSESEARCH-<key> MEDIADBDELETE<id>, <success> MEDIADBEND-<key> MEDIADBPROP<id>, <key>, <value> processDeleteRecordEvent(String, boolean) IMediaDBComponentListener processEndOfSetEvent(String) processMediaDBPropertiesEvent(String, Properties) IMediaDBComponentListener IMediaDBComponentListener processQueryDBEvent(MediaRecord) IMediaDBComponentListener MEDIADBRECORD<key>, <id>, <#>, <name >, <record type>, <url> processSearchDBEvent(MediaSearchSet) IMediaDBComponentListener MEDIADBSEARCHRESULT<key>, <count> processStartOfSetEvent(String) processUpdateRecordEvent(String, boolean) IMediaDBComponentListener IMediaDBComponentListener MEDIADBSTART<key> MEDIADBUPDATE<id>, <success> 124 125 cycleMediaDeviceRandom() cycleMediaDeviceRepeat() getMediaDeviceSource() IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent 78 Standard NetLinx API (SNAPI) R 1. 8. 0 Digital Media Server Functions (Cont. ) Name queryMediaDeviceProperties() Component IMediaDeviceComponent Channel Level Command ?DECODEPROPS Constant Notes Query for all Media Device Properties, responds with multiple DECODEPROP<key>, <value>, one for each property, where <key> is the property key and <value> is the property value. Query for one Media Device Properties, responds with DECODEPROP<key>, <value> where <key> is the property key and <value> is the property value. Turn media counter notification on or off, where <state> is 1 or 0 MEDIA_RANDOM_DISC_O N MEDIA_RANDOM_ALL_ON Momentary Function Channel: Randomdisc is on while channel is active Momentary Function Channel: Random-all is on while channel is active queryMediaDeviceProperty(sKeyName) IMediaDeviceComponent ?DECODEPROP<key> setMediaDeviceCounterNotificationOn(state) setMediaDeviceRandomState(RANDOM_DISC) setMediaDeviceRandomState(RANDOM_ALL) setMediaDeviceRandomState(RANDOM_OFF) setMediaDeviceRepeatState(REPEAT_DISC) setMediaDeviceRepeatState(REPEAT_TRACK) setMediaDeviceRepeatState(REPEAT_ALL) setMediaDeviceRepeatState(REPEAT_OFF) setMediaDeviceSource(cURISource) processMediaDeviceCounterEvent(MediaTime) IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponent IMediaDeviceComponentListener 178 179 180 181 182 183 184 MEDIACOUNTERNOTIFY-<state> MEDIA_RANDOM_OFF_ON Momentary Function Channel: Random-off is on while channel is active MEDIA_REPEAT_DISC_ON MEDIA_REPEAT_TRACK_ ON MEDIA_REPEAT_ALL_ON MEDIA_REPEAT_OFF_ON DECODESOURCE<url> MEDIACOUNTER<counter> DECODEPROP<key>, <value> Momentary Function Channel: Repeat-disc is on while channel is active Momentary Function Channel: Repeattrack is on while channel is active Momentary Function Channel: Repeat-all is on while channel is active Momentary Function Channel: Repeat-off is on while channel is active Set Media Device Source where <url> is the URL of the source. Media counter changed, where <counter> is a String in the format [-]hh:mm:ss. ff Media property value where <key> is the property key and <value> is the property value. MEDIA_RANDOM_DISC_F B MEDIA_RANDOM_ALL_FB MEDIA_RANDOM_OFF_FB MEDIA_REPEAT_DISC_FB MEDIA_REPEAT_TRACK_F B Feedback Channel: Random state change (see chart below) Feedback Channel: Random state change (see chart below) Feedback Channel: Random state change (see chart below) Feedback Channel: Repeat state change (see chart below) Feedback Channel: Repeat state change (see chart below) processMediaDevicePropertiesEvent(Proper- IMediaDeviceComponentListener ties) processMediaDeviceRandomStateEvent(RANDOM_DISC) processMediaDeviceRandomStateEvent(RANDOM_ALL) processMediaDeviceRandomStateEvent(RANDOM_OFF) processMediaDeviceRepeatStateEvent(REPEAT_DISC) processMediaDeviceRepeatStateEvent(REPEAT_TRACK) IMediaDeviceComponentListener IMediaDeviceComponentListener IMediaDeviceComponentListener IMediaDeviceComponentListener IMediaDeviceComponentListener 178 179 180 181 182 Standard NetLinx API (SNAPI) R 1. 8. 0 79 Digital Media Server Functions (Cont. ) Name processMediaDeviceRepeatStateEvent(REPEAT_ALL) processMediaDeviceRepeatStateEvent(REPEAT_OFF) processMediaDeviceSourceInfoEvent (MediaDeviceSourceInfo ) Component IMediaDeviceComponentListener IMediaDeviceComponentListener IMediaDeviceComponentListener Channel Level Command 183 184 DECODESOURCE<recordID>, <name>, <url> 45 46 47 48 51 52 53 54 10 11 12 13 14 15 16 17 18 MENU_UP MENU_DN MENU_LT MENU_RT MENU_UP_LT MENU_UP_RT MENU_DN_LT MENU_DN_RT DIGIT_0 DIGIT_1 DIGIT_2 DIGIT_3 DIGIT_4 DIGIT_5 DIGIT_6 DIGIT_7 DIGIT_8 Constant MEDIA_REPEAT_ALL_FB MEDIA_REPEAT_OFF_FB Notes Feedback Channel: Repeat state change (see chart below) Feedback Channel: Repeat state change (see chart below) Media Device Source changed where <recordID> is the record ID of the source (may be blank), <name> is the name of the source and <url> is the URL of the source. Momentary Function Channel: Move menu cursor UP Momentary Function Channel: Move menu cursor DOWN Momentary Function Channel: Move menu cursor LEFT Momentary Function Channel: Move menu cursor RIGHT Momentary Function Channel: Move menu cursor UP_LEFT Momentary Function Channel: Move menu cursor UP_RIGHT Momentary Function Channel: Move menu cursor DOWN_LEFT Momentary Function Channel: Move menu cursor DOWN_RIGHT Momentary Function Channel: Press menu button DIGIT_0 Momentary Function Channel: Press menu button DIGIT_1 Momentary Function Channel: Press menu button DIGIT_2 Momentary Function Channel: Press menu button DIGIT_3 Momentary Function Channel: Press menu button DIGIT_4 Momentary Function Channel: Press menu button DIGIT_5 Momentary Function Channel: Press menu button DIGIT_6 Momentary Function Channel: Press menu button DIGIT_7 Momentary Function Channel: Press menu button DIGIT_8 moveMenuCursor(UP) moveMenuCursor(DOWN) moveMenuCursor(LEFT) moveMenuCursor(RIGHT) moveMenuCursor(UP_LEFT) moveMenuCursor(UP_RIGHT) moveMenuCursor(DOWN_LEFT) moveMenuCursor(DOWN_RIGHT) pressMenuButton(DIGIT_0) pressMenuButton(DIGIT_1) pressMenuButton(DIGIT_2) pressMenuButton(DIGIT_3) pressMenuButton(DIGIT_4) pressMenuButton(DIGIT_5) pressMenuButton(DIGIT_6) pressMenuButton(DIGIT_7) pressMenuButton(DIGIT_8) IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent 80 Standard NetLinx API (SNAPI) R 1. 8. 0 Digital Media Server Functions (Cont. ) Name pressMenuButton(DIGIT_9) pressMenuButton(PLUS_10) pressMenuButton(ENTER) pressMenuButton(CANCEL) pressMenuButton(MENU) pressMenuButton(EXIT) pressMenuButton(VIDEO) pressMenuButton(THUMBS_DOWN) pressMenuButton(THUMBS_UP) pressMenuButton(ACCEPT) pressMenuButton(REJECT) pressMenuButton(LIVE_TV) pressMenuButton(SLEEP) pressMenuButton(PPV) pressMenuButton(FUNCTION) pressMenuButton(SETUP) pressMenuButton(XM) pressMenuButton(FM) pressMenuButton(AM) pressMenuButton(CLEAR) Component IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent Channel Level Command 19 20 21 43 44 50 57 58 59 60 61 62 63 64 65 66 77 78 79 80 Constant DIGIT_9 MENU_PLUS_10 MENU_ENTER MENU_CANCEL MENU_FUNC MENU_EXIT MENU_VIDEO MENU_THUMBS_DN MENU_THUMBS_UP MENU_ACCEPT MENU_REJECT MENU_LIVE_TV MENU_SLEEP MENU_PPV MENU_FUNCTION MENU_SETUP MENU_XM MENU_FM MENU_AM MENU_CLEAR Notes Momentary Function Channel: Press menu button DIGIT_9 Momentary Function Channel: Press menu button PLUS_10 Momentary Function Channel: Press menu button ENTER Momentary Function Channel: Press menu button CANCEL Momentary Function Channel: Press menu button MENU Momentary Function Channel: Press menu button EXIT Momentary Function Channel: Press menu button VIDEO Momentary Function Channel: Press menu button THUMBS_DOWN Momentary Function Channel: Press menu button THUMBS_UP Momentary Function Channel: Press menu button ACCEPT to answer an incoming call Momentary Function Channel: Press menu button REJECT to reject an incoming call Momentary Function Channel: Press menu button LIVE_TV Momentary Function Channel: Press menu button SLEEP Momentary Function Channel: Press menu button PPV Momentary Function Channel: Press menu button FUNCTION Momentary Function Channel: Press menu button SETUP Momentary Function Channel: Press menu button XM Momentary Function Channel: Press menu button FM Momentary Function Channel: Press menu button AM Momentary Function Channel: Press menu button CLEAR Standard NetLinx API (SNAPI) R 1. 8. 0 81 Digital Media Server Functions (Cont. ) Name pressMenuButton(BACK) pressMenuButton(FORWARD) pressMenuButton(ADVANCE) pressMenuButton(DIMMER) pressMenuButton(HOLD) pressMenuButton(LIST) pressMenuButton(LEFT_PAREN) pressMenuButton(RIGHT_PAREN) pressMenuButton(UNDER_SCORE) pressMenuButton(DASH) pressMenuButton(ASTERISK) pressMenuButton(DOT) pressMenuButton(POUND) pressMenuButton(COMMA) pressMenuButton(DIAL) pressMenuButton(CONFERENCE) pressMenuButton(PLUS_100) pressMenuButton(PLUS_1000) pressMenuButton(DISPLAY) pressMenuButton(SUBTITLE) Component IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent Channel Level Command 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 Constant MENU_BACK MENU_FORWARD MENU_ADVANCE MENU_DIMMER MENU_HOLD MENU_LIST MENU_LT_PAREN MENU_RT_PAREN MENU_UNDERSCORE MENU_DASH MENU_ASTERISK MENU_DOT MENU_POUND MENU_COMMA MENU_DIAL MENU_CONFERENCE MENU_PLUS_100 MENU_PLUS_1000 MENU_DISPLAY MENU_SUBTITLE Notes Momentary Function Channel: Press menu button BACK Momentary Function Channel: Press menu button FORWARD Momentary Function Channel: Press menu button ADVANCE Momentary Function Channel: Press menu button DIMMER Momentary Function Channel: Press menu button HOLD Momentary Function Channel: Press menu button LIST Momentary Function Channel: Press menu button LEFT_PAREN Momentary Function Channel: Press menu button RIGHT_PAREN Momentary Function Channel: Press menu button UNDER_SCORE Momentary Function Channel: Press menu button DASH Momentary Function Channel: Press menu button ASTERISK Momentary Function Channel: Press menu button DOT Momentary Function Channel: Press menu button POUND Momentary Function Channel: Press menu button COMMA Momentary Function Channel: Press menu button DIAL Momentary Function Channel: Press menu button CONFERENCE Momentary Function Channel: Press menu button PLUS_100 Momentary Function Channel: Press menu button PLUS_1000 Momentary Function Channel: Press menu button DISPLAY Momentary Function Channel: Press menu button SUBTITLE 82 Standard NetLinx API (SNAPI) R 1. 8. 0 Digital Media Server Functions (Cont. ) Name pressMenuButton(INFO) pressMenuButton(FAVORITES) pressMenuButton(CONTINUE) pressMenuButton(RETURN) pressMenuButton(GUIDE) pressMenuButton(PAGE_UP) pressMenuButton(PAGE_DOWN) pressMenuButton(DECK_A_B) pressMenuButton(TV_VCR) pressMenuButton(RECORD_SPEED) pressMenuButton(PROGRAM) pressMenuButton(AB_REPEAT) pressMenuButton(HELP) pressMenuButton(TITLE) pressMenuButton(TOP_MENU) pressMenuButton(ZOOM) pressMenuButton(ANGLE) pressMenuButton(AUDIO) pressMenuButton(PREVIEW_INPUT) pressMenuButton(SEND_INPUT) Component IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent Channel Level Command 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 129 130 Constant MENU_INFO MENU_FAVORITES MENU_CONTINUE MENU_RETURN MENU_GUIDE MENU_PAGE_UP MENU_PAGE_DN MENU_DECK_A_B MENU_TV_VCR MENU_RECORD_SPEED MENU_PROGRAM MENU_AB_REPEAT MENU_HELP MENU_TITLE MENU_TOP_MENU MENU_ZOOM MENU_ANGLE MENU_AUDIO MENU_PREVIEW_INPUT MENU_SEND_INPUT Notes Momentary Function Channel: Press menu button INFO Momentary Function Channel: Press menu button FAVORITES Momentary Function Channel: Press menu button CONTINUE Momentary Function Channel: Press menu button RETURN Momentary Function Channel: Press menu button GUIDE Momentary Function Channel: Press menu button PAGE_UP Momentary Function Channel: Press menu button PAGE_DOWN Momentary Function Channel: Press menu button DECK_A_B Momentary Function Channel: Press menu button TV_VCR Momentary Function Channel: Press menu button RECORD_SPEED Momentary Function Channel: Press menu button PROGRAM Momentary Function Channel: Press menu button AB_REPEAT Momentary Function Channel: Press menu button HELP Momentary Function Channel: Press menu button TITLE Momentary Function Channel: Press menu button TOP_MENU Momentary Function Channel: Press menu button ZOOM Momentary Function Channel: Press menu button ANGLE Momentary Function Channel: Press menu button AUDIO Momentary Function Channel: Press menu button PREVIEW_INPUT Momentary Function Channel: Press menu button SEND_INPUT Standard NetLinx API (SNAPI) R 1. 8. 0 83 Digital Media Server Functions (Cont. ) Name pressMenuButton(SEND_GRAPHICS) pressMenuButton(FLASH) pressMenuButton(RESET) pressMenuButton(INSTANT_REPLAY) pressMenuButton(A) pressMenuButton(B) pressMenuButton(C) pressMenuButton(D) pressMenuButton(E) pressMenuButton(F) pressMenuButton(G) pressMenuButton(H) pressMenuButton(I) pressMenuButton(J) pressMenuButton(K) pressMenuButton(L) pressMenuButton(M) pressMenuButton(N) pressMenuButton(O) pressMenuButton(P) pressMenuButton(Q) pressMenuButton(R) pressMenuButton(S) pressMenuButton(T) pressMenuButton(U) pressMenuButton(V) pressMenuButton(W) pressMenuButton(X) pressMenuButton(Y) pressMenuButton(Z) Component IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent IMenuComponent Channel Level Command 131 203 215 218 ALPHA-A ALPHA-B ALPHA-C ALPHA-D ALPHA-E ALPHA-F ALPHA-G ALPHA-H ALPHA-I ALPHA-J ALPHA-K ALPHA-L ALPHA-M ALPHA-N ALPHA-O ALPHA-P ALPHA-Q ALPHA-R ALPHA-S ALPHA-T ALPHA-U ALPHA-V ALPHA-W ALPHA-X ALPHA-Y ALPHA-Z Constant MENU_SEND_GRAPHICS MENU_FLASH MENU_RESET MENU_INSTANT_REPLAY Notes Momentary Function Channel: Press menu button SEND_GRAPHICS Momentary Function Channel: Press menu button FLASH Momentary Function Channel: Press menu button RESET Momentary Function Channel: Press menu button INSTANT_REPLAY Press menu button A Press menu button B Press menu button C Press menu button D Press menu button E Press menu button F Press menu button G Press menu button H Press menu button I Press menu button J Press menu button K Press menu button L Press menu button M Press menu button N Press menu button O Press menu button P Press menu button Q Press menu button R Press menu button S Press menu button T Press menu button U Press menu button V Press menu button W Press menu button X Press menu button Y Press menu button Z 84 Standard NetLinx API (SNAPI) R 1. 8. 0 Digital Media Server Functions (Cont. ) Name selectMenuItem() getDebugState() Component IMenuComponent IModuleComponent Channel Level Command 49 ?DEBUG Constant MENU_SELECT Notes Momentary Function Channel: Select current menu item Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO Query for the device firmware version, responds with FWVERSION-<version> Query for the value of property <key>, respond with PROPERTY-<key>, <value> Query for the module version, responds with VERSION-<version> Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules. Send a message directly to the device Reinitialize communication with the device Set the debug state where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO Set the device date/time. When passback is on, all response from the device will be passed back to the NetLinx program as a string from the virtual device Set the value of property <key> to <value> DATA_INITIALIZED DEBUG-<state> 251 DEVICE_COMMUNICATIN G Feedback Channel: Module data is synchronized with device while channel is on Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO Feedback Channel: Communication is established with device while channel is on When passback is on, each string received form the device is sent to the NetLinx program as a string. Use a DATA_EVENT event with a STRING handler to caputre the data from the device. ENCODESINKADD<url> Add an Output Stream Sink where <url> is the URL of the sink to be added. getFWVersion() getProperty(key) getVersion() loadProperties(fileName) IModuleComponent IModuleComponent IModuleComponent IModuleComponent ?FWVERSION ?PROPERTY-<key> ?VERSION LOADPROPERTY<file> passThru(buffer) reinitialize() setDebugState(state) setDeviceDateTime(date) setPassbackOn(boolean) IModuleComponent IModuleComponent IModuleComponent IModuleComponent IModuleComponent PASSTHRU-<buffer> REINIT DEBUG-<state> CLOCK-<mm/dd/yyyy> <hh:mm:ss> PASSBACK-<state> setProperty(key, value) processDataInitializedEvent(boolean) processDebugEvent(int) processDeviceOnLineEvent(boolean) processPassbackEvent(byte[]) IModuleComponent IModuleComponentListener IModuleComponentListener IModuleComponentListener IModuleComponentListener 252 PROPERTY<key>, <value> addOutputStreamSink(cURISink) IOutputStreamComponent Standard NetLinx API (SNAPI) R 1. 8. 0 85 Digital Media Server Functions (Cont. ) Name getOutputStreamSinks() Component IOutputStreamComponent Channel Level Command ?ENCODESINK Constant Notes 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. Query for Output Stream Source, responds with ENCODESOURCE-<url> where <ur> is the URL for the source. Query for all Output Stream Media Properties, responds with multiple ENCODEPROP-<key>, <value>, one for each property, where <key> is the property key and <value> is the property value. Query for one Output Stream Media Properties, responds with ENCODEPROP<key>, <value> where <key> is the property key and <value> is the property value. Remove an Output Stream Sink where <url> is the URL of the sink to be removed. Set an Output Stream Property where <key> is the property key and <value> is the property value. Output Stream Property value where <key> is the property key and <value> is the property value. Output Stream Sink added where <url> is the URL of the added sink. Output Stream Sink removed where <url> is the URL of the removed sink. [. . . ] 26 138 ?VOLPRESET VOLPRESETSAVE<preset> 1 199 VOLPRESET-<preset> VOL_LVL VOL_MUTE_ON VOL_MUTE VOL_PRESET Momentary Function Channel: Cycle volume mute when channel is activated Momentary Function Channel: Cycle camera preset when channel is activated Query for volume preset, responds with VOLPRESET-<preset> Save Volume Preset where <preset> is 1 to x and x is the maximum supported preset (see specific module documentation) Set volume, range is 0-255 Discrete Function Channel: Volume mute is on while channel is active Recall volume preset where <preset> is 1 to x and x is the maximum supported preset (see specific module documentation) VOL_UP VOL_DN 1 199 VOLPRESET-<preset> VOL_LVL VOL_MUTE_FB Ramping Channel: Volume is ramped up while channel is active Ramping Channel: Volume is ramped down while channel is active Volume changed, range is 0-255 Feedback Channel: Volume is muted if channel is on Volume preset changed, where <preset> is 1-x and x is the maximum supported preset (see specific module documentation) VOL_UP_FB VOL_DN_FB Feedback Channel: Volume is ramping up while channel is on Feedback Channel: Volume is ramping down while channel is on cycleVolumeMute() cycleVolumePreset() getVolumePreset() saveVolumePreset(preset) IVolumeComponent IVolumeComponent IVolumeComponent IVolumeComponent setVolume(level) setVolumeMuteOn(state) setVolumePreset(preset) IVolumeComponent IVolumeComponent IVolumeComponent setVolumeRamp(UP) setVolumeRamp(DOWN) processVolumeEvent(int) processVolumeMuteEvent(boolean) processVolumePresetEvent(int) IVolumeComponent IVolumeComponent IVolumeComponentListener IVolumeComponentListener IVolumeComponentListener 24 25 processVolumeRampEvent(UP) processVolumeRampEvent(DOWN) IVolumeComponentListener IVolumeComponentListener 24 25 332 Standard NetLinx API (SNAPI) R 1. 8. 0 Weather IModuleComponent IModuleComponentListener IWeatherComponent IWeatherComponentListener Name: Weather Interface: IWeather Weather Functions Name getDebugState() Component IModuleComponent Channel Level Command ?DEBUG Constant Notes Query the debug level, responds with DEBUG-<state> where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO Query for the device firmware version, responds with FWVERSION-<version> Query for the value of property <key>, respond with PROPERTY-<key>, <value> Query for the module version, responds with VERSION-<version> Load properties from the file with the supplied filename. Used to load meta-data properties for modules including Generic IR modules. Send a message directly to the device Reinitialize communication with the device Set the debug state where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO Set the device date/time. When passback is on, all response from the device will be passed back to the NetLinx program as a string from the virtual device Set the value of property <key> to <value> DATA_INITIALIZED DEBUG-<state> 251 Feedback Channel: Module data is synchronized with device while channel is on Debug state changed where <state> is 1-4 for ERROR, WARNING, DEBUG, INFO DEVICE_COMMUNICATING Feedback Channel: Communication is established with device while channel is on getFWVersion() getProperty(key) getVersion() loadProperties(fileName) IModuleComponent IModuleComponent IModuleComponent IModuleComponent ?FWVERSION ?PROPERTY-<key> ?VERSION LOADPROPERTY<file> passThru(buffer) reinitialize() setDebugState(state) setDeviceDateTime(date) setPassbackOn(boolean) IModuleComponent IModuleComponent IModuleComponent IModuleComponent IModuleComponent PASSTHRU-<buffer> REINIT DEBUG-<state> CLOCK-<mm/dd/yyyy> <hh:mm:ss> PASSBACK-<state> setProperty(key, value) processDataInitializedEvent(boolean) processDebugEvent(int) processDeviceOnLineEvent(boolean) IModuleComponent IModuleComponentListener IModuleComponentListener IModuleComponentListener 252 PROPERTY<key>, <value> Standard NetLinx API (SNAPI) R 1. 8. 0 333 Weather Functions (Cont. ) Name processPassbackEvent(byte[]) Component IModuleComponentListener Channel Level Command Constant Notes When passback is on, each string received form the device is sent to the NetLinx program as a string. [. . . ]