MTX3, MTX5-D, XMV Series, EXi8, EXo8 Remote Control Protocol Specifications Version 1.0.3 Release May 23rd, 2014 This specification document applies to MTX3, MTX5-D, XMV, EXi8, and EXo8 V1.20 and later.
0. Revision History Version V1.0.0 V1.0.1 Date Sep. 1, 2013 Sep. 25, 2013 V1.0.2 Jan.14, 2014 V1.0.3 May 23, 2014 Section 7 7 8 3.1 3.1 3.2.4 3.2.4, 3.4.3 3.2.4, 3.4.3 3.3.1 3.3.3 3.4.3 4 4 6 7 7 7 8 3.3.
1. Setup 1.1. Connection Procedure Connection when using the NETWORK connector to perform remote control using this protocol MTX3 Remote Controller Ethernet Network Switch Ethernet Ethernet Network Switch Ethernet MTX5-D Remote Controller * Also for XMV, EXi8 and EXo8. XMV can be controlled with the protocol in this document without MTX3 or MTX5-D.
1. Setup 1.3. Device Configuration 1.3.1. MTX3 and MTX5-D MTX3 and MTX5-D can be controlled from an external controller through a NETWORK and RS-232C connector. Two remote controllers can connect simultaneously via two available ports. The first controller is fixed to using the NETWORK connector while the second controller can use the NETWORK or RS-232C connector.
2. Command List 1. Commands from a device sent to a remote controller No. 1-1 Device status change 1-2 notification 1-3 Reply from device NOTIFY devstatus runmode ... NOTIFY devstatus error ... NOTIFY devstatus fs ... 1-4 1-5 NOTIFY devstatus lockstatus ... NOTIFY set ... NOTIFY setn ... NOTIFY set(setn) MTX:EvntScd_On ... NOTIFY mtr ... NOTIFY sscurrent ...
2. Command List 3. Extended commands No.
3. Command Specifications 3. Command Specifications 3.1. Basic Command Specifications Below is the syntax of commands exchanged between a device and remote controller.
3. Command Specifications 3.2. Commands a Device Sends to a Remote Controller 3.2.1. Device status change notification 1-1) Device run mode notification Command NOTIFY devstatus Example: Option 1 runmode Option 2 "emergency" "update" "normal" Description Emergency run mode Update mode Normal run mode Notification: NOTIFY devstatus runmode "normal" Meaning: The run mode was changed to normal mode.
3. Command Specifications 3.2.2.
3. Command Specifications 3.2.4. Event processing change notification 1-9) Media insertion notification Command NOTIFY event Option 1 MTX:Media Option 2 "sdcard=inserted" "sdcard=extracted" Description An SD memory card was inserted. An SD memory card was removed. Example: Notification: NOTIFY event MTX:Media "sdcard=inserted" Meaning: An SD memory card was inserted into an SD memory card slot and was detected normally. * SD Card should not be removed when the MTX is powered on.
3.
3. Command Specifications 1-19) Play, stop, and other transport operation notification Command NOTIFY event Example: Option 1 MTX:AudioPlayerTransport Option 2 "operation=stop" "operation=play" "operation=pause" Description Stop Play Pause Notification: NOTIFY event MTX:AudioPlayerTransport "operation=stop" Meaning: Playback was paused.
3.
3. Command Specifications 3.3.2. Device run mode query 2-5) Emergency run mode change Command Option 1 devmode normal emergency Description Sets the run mode to normal Sets the run mode to emergency Response Response string OK devmode normal OK devmode emergency Example: Command: Response: Meaning: Description Normal run mode change complete Emergency run mode change complete devmode emergency OK devmode emergency Change to emergency mode. Run mode was changed to emergency. 3.3.3.
3. Command Specifications 2-8) Normalization resolution setting Command scpmode Details: Option 1 resolution Option 2 (res) Description Resolution for normalized value notifications (default setting = 1000) (res) = Resolution for normalized values Response Response string OK scpmode resolution xxxx Details: Description The resolution for normalized value notifications xxxx = Specified resolution Example: Command: Response: Meaning: * Specified resolution should be more than 100.
3. Command Specifications 3.3.4. Parameter query 2-10) Raw value parameter query Command get Details: Option 1 MTX:mem_MemNo/UniqueId/ElmNo/Xpos/ Ypos/PrmNo/IndexNo MemNo = UniqueId = Xpos = Ypos = IndexNo = Option 2 0 Option 3 0 Description Raw value parameter query request See section 7, "Parameter Values." See section 7, "Parameter Values." See section 7, "Parameter Values." See section 7, "Parameter Values." See section 7, "Parameter Values.
3. Command Specifications 2-12) Scheduler status query Command get(getn,gett) Option 1 Option 2 MTX:EvntScd_On 0 Option 3 0 Description Queries the scheduler status * For getn, the response will contain a normalized value; for gett, the response will contain a text string.
3. Command Specifications 2-14) Normalized value parameter setting Command setn Details: Option 1 MTX:mem_MemNo/UniqueId/ElmNo/ Xpos/Ypos/PrmNo/IndexNo MemNo = UniqueId = Xpos = Ypos = IndexNo = (value) = Option 2 0 Option 3 Option 4 (value) 0 Description Normalized value parameter setting See section 7, "Parameter Values." See section 7, "Parameter Values." See section 7, "Parameter Values." See section 7, "Parameter Values." See section 7, "Parameter Values." See section 3.
3. Command Specifications 3.3.6. Meter control 2-16) Transmission request Command mtrstart Details: Option 1 Option 3 MTX:mtr_MemNo/UniqueId/meter (interval) MTX:mtr_MemNo/UniqueId/hold Description Requests that the specified meter data be transmitted. Requests that the specified hold meter data be transmitted. MemNo = See section 7, "Parameter Values." UniqueId = See section 7, "Parameter Values.
3. Command Specifications 3.3.7. Snapshot (preset) processing 2-18) Snapshot (preset) current number query processing Command Description Queries the current preset number (index) sscurrent Response Response string OK sscurrent (index) unmodified Description Current preset number queried (There is no parameter change after recalling.) Current preset number queried (There is a parameter change after recalling.
3. Command Specifications 3-2) Parameter set version query Command Option 1 paramsetver devinfo Description Queries the parameter set version Response Response string OK devinfo paramsetver "xxxx" Details: Description Parameter set version xxxx = Version Example: Command: Notification: Meaning: devinfo paramsetver OK devinfo paramsetver "MTX:1.2.0" Query the parameter set version. Parameter set version = V1.2.
3. Command Specifications 3-6) Device ID query Command Option 1 devinfo deviceid Description Queries the device ID Response Response string OK devinfo deviceid "xxxx" Description Device ID Details: xxxx = Device ID * 3-digit hexadecimal Example: Command: Notification: Meaning: Note: devinfo deviceid OK devinfo deviceid "001" Query the device ID. Device ID = "001" The device ID corresponds to the UNIT ID.
3. Command Specifications 3-9) Nth preset information Command Option 1 ssinfo (index) Description Queries the preset information at the specified index in the preset list. Response Response string OK ssinfo (index) "xxxxxx" (attrib) "yyyyyy" "zzzzzz" Description Preset information at the specified index in the preset list.
3. Command Specifications 3-11) Time synchronization Command event Details: yyyy = mm = dd = hh = mm = ss = Option 1 MTX:SetAbsoluteTime Option 2 "yyyy/mm/dd hh:mm:ss" Description Changes the time Year (Gregorian) Month (1 to 12) Day (1 to 31) Hour (0 to 23) Minute (0 to 59) Second (0 to 59) * DST (Daylight Saving Time) is not accounted for.
3.
3.
3.
3.
3. Command Specifications 3-27) Current folder information (for list) query Command event Option 1 MTX:AudioPlayerGetCurrentDir Option 2 "" Description Queries the current folder information. Response Response string OK event MTX:AudioPlayerGetCurrentDir "dirpath=xxxx|dirname=yyyy| subdirnum=zzzz|filenum=wwww" OKm event MTX:AudioPlayerGetCurrentDir "sdcard is not inserted" Description Current folder information There is no SD memory card inserted.
3. Command Specifications 3-30) File name query Command Option 1 MTX:AudioPlayerGetFileName event Details: Option 2 "fileindex=xxxx" Description File name query xxxx = Index number Response Response string OK event MTX:AudioPlayerGetFileName "filename=xxxx" OKm event MTX:AudioPlayerGetFileName "sdcard is not inserted" Description File name There is no SD memory card inserted. * OKm is returned if there is no SD memory card inserted.
3.
3.
3.
3.
3. Command Specifications 3-42) Query for alert event log as list Command event Details: Option 1 MTX:EventLogGetLogList Option 2 "logindex=xxxx-xxxx" Description Query for event log list xxxx-xxxx= First index number - Last index number Remark: Do not allow exceed number of event log. First index number should be less than Last index number. One message can query up to 10 logs.
3. Command Specifications 3.5. Command Errors 3.5.1. Command Error Notifications Error notification that indicates errors in commands. If an error is found when the command is sent, this notification is returned instead of the normal successful notification. [Notification syntax] Command name Error code ERROR Alphanumeric Alphanumeric Name of the command that caused the error Error description * See the error codes below.
4. Command Sequence Below are examples of how to process remote control. When viewed from the controller, the following major phases exist in order to perform remote control. Start procedure Communication start • Wait for the device to start (devstatus) Initial setting • MTX external control protocol setting (scpmode) • Parameter syncing (get, set, etc.) Normal procedure • Detect operation of controls. • Receive communication from the device. Detects the operation of controls by the user.
4. Command Sequence Communication start sequence The amount of time for the controller and the controlled device to start is different. Remote control is an act of controlling the controlled device from the controller, so the controller must wait for the controlled device to become ready. The controller needs to wait using the sequence below. 1. If an Ethernet connection is required, the remote controller needs to establish a logical session, with the MTX device(s) based on IP address(es) and port number.
4. Command Sequence Example when the controlled device starts earlier than the controller Remote controller Connected physically Controlled device Starting Device starting Device normal running Connection unknown devstatus runmode OK devstatus runmode "normal" Connection detection * With the first devstatus runmode request, a result notification is returned. Controller can recognize that Controlled device is ready to receive commands when there is response for "devstatus runmode" command.
4. Command Sequence Parameter sync sequence Immediately after communication starts, the controller does not know anything about the most recent status of the controlled device. Therefore, the controller must query all parameters that it plans to handle. This also applies for when preset recall is executed, because the controller does not know how the device has changed.
4. Command Sequence Applying the most recent status of the controller to the device Remote controller Controlled device Normally running Connection detection Normally running Communication possible set MTX:mem_512/60000/0/0/0/0/0 0 0 -7760 OK set MTX:mem_512/60000/0/0/0/0/0 0 0 -7760 "-77.
4. Command Sequence Meter data request/query sequence The controller requests meter data by specifying the meter data address and the minimum transmission interval. The meter transmission stops after 10 seconds. To continue receiving data, make another request before the 10 seconds pass. Remote controller Controlled device mtrstart MTX:mtr_512/20020/level 1000 OutputLevelMeter request Start measuring 10 seconds OK mtrstart MTX:mtr_512/20020/level NOTIFY mtr MTX:mtr_512/20020/level level 71 71 ...
4. Command Sequence Sequence when parameters are changed by another controller If the controller sends a parameter set request, a change notification is returned immediately. However, if parameters change internally in the controlled device (this includes changes in parameters that occur as a result of a controller operation on another parameter) or due to a request from another controller, a parameter change notification is received, as shown below.
5. Meter Value 1.
6. Parameter Value Details 1.
6. Parameter Value Details 3. GATE DECAY Value Displayed value Value Displayed value Value Displayed value Value Displayed value 0 3msec 43 189msec 86 1.23sec 129 7.68sec 1 7msec 44 196msec 87 1.28sec 130 8.11sec 2 10msec 45 203msec 88 1.34sec 131 8.54sec 3 13msec 46 209msec 89 1.39sec 132 8.97sec 4 17msec 47 219msec 90 1.44sec 133 9.39sec 5 22msec 48 229msec 91 1.50sec 134 9.82sec 6 25msec 49 243msec 92 1.55sec 135 10.2sec 7 28msec 50 256msec 93 1.60sec 136 10.7sec 8 32msec 51 269msec 94 1.66sec 137 11.
6. Parameter Value Details HOLD Value Displayed value Value Displayed value Value Displayed value Value Displayed value 0 0.02msec 54 2.01msec 108 20.2msec 162 211msec 1 0.04msec 55 2.10msec 109 20.9msec 163 222msec 2 0.07msec 56 2.19msec 110 21.6msec 164 233msec 3 0.09msec 57 2.28msec 111 22.6msec 165 245msec 4 0.11msec 58 2.36msec 112 23.6msec 166 256msec 5 0.14msec 59 2.45msec 113 25.0msec 167 267msec 6 0.16msec 60 2.54msec 114 26.4msec 168 278msec 7 0.18msec 61 2.62msec 115 27.8msec 169 289msec 8 0.
6. Parameter Value Details 4. COMPRESSOR RATIO Value Displayed value Value Displayed value Value Displayed value Value Displayed value 10 1.0:1 58 5.8:1 106 10.6:1 154 15.4:1 11 1.1:1 59 5.9:1 107 10.7:1 155 15.5:1 12 1.2:1 60 6.0:1 108 10.8:1 156 15.6:1 13 1.3:1 61 6.1:1 109 10.9:1 157 15.7:1 14 1.4:1 62 6.2:1 110 11.0:1 158 15.8:1 15 1.5:1 63 6.3:1 111 11.1:1 159 15.9:1 16 1.6:1 64 6.4:1 112 11.2:1 160 16.0:1 17 1.7:1 65 6.5:1 113 11.3:1 161 16.1:1 18 1.8:1 66 6.6:1 114 11.4:1 162 16.2:1 19 1.9:1 67 6.
6. Parameter Value Details 5. AGC RESPONSE TIME Value Displayed value Value Displayed value 0 100msec 30 2.20sec 1 150msec 31 2.30sec 2 200msec 32 2.40sec 3 250msec 33 2.50sec 4 300msec 34 2.60sec 5 350msec 35 2.70sec 6 400msec 36 2.80sec 7 450msec 37 2.90sec 8 500msec 38 3.00sec 9 550msec 39 3.10sec 10 600msec 40 3.20sec 12 700msec 42 3.40sec 13 750msec 43 3.50sec 14 800msec 44 3.60sec 15 850msec 45 3.70sec 16 900msec 46 3.80sec 17 950msec 47 3.90sec 18 1.00sec 48 4.00sec 19 1.10sec 49 4.10sec 20 1.
6. Parameter Value Details 6. EFFECT TYPE Value 0 1 2 3 Displayed value Reverb Hall Reverb Stage1 Karaoke Echo Vocal Echo RevHallTime/RevStageTime Value 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 Time(sec) 0.3 0.4 0.5 0.6 0.7 0.8 0.9 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 3.0 3.1 Value 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 KaraokeTime/VocalTime Time(sec) 3.2 3.3 3.4 3.5 3.6 3.7 3.
6. Parameter Value Details 7.
6. Parameter Value Details 8.
6. Parameter Value Details 9.
6. Parameter Value Details 11.
6. Parameter Value Details 12.
6. Parameter Value Details 13. MY4-AEC FBS WIDTH Value 0 1 2 DEPTH Displayed Value 1/10oct 1/60oct 1/93oct Value 0 1 2 Displayed Value -6dB -12dB -18dB 14. MY4-AEC Digtal I/O SRC FsType Value 0 1 2 3 4 5 Displayed value 44.1kHz 48kHz 88.2kHz 96kHz AES/EBU IN CH1/2 AES/EBU IN CH3/4 MTX3/MTX5-D/XMV Series/EXi8/EXo8 Remote Control Protocol Specifications V1.0.
7. Parameter List MTX3/MTX5-D Model Access ID MemNo ElmNo Xpos Ypos MTX3 MTX5-D (Memory UniqueId (Element (X Position) (Y Position) Number) Number) o o 512 50000 0 0-7 0 (1-8ch) o o o PrmNo (Parameter Number) 0 1 IndexNo Category (Index Number) 0 INPUT INTERNAL PORT HA o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o o INPUT PATCH InputPatch In 30(62) Input x 22(30) Output Patch NONE YDIF IN 16 (SLOT 16) PreInputSection In Phase OFF ON - 0:OFF 1:ON Gain -96.0 24.
7.
7.
7. Parameter List Model Access ID MemNo ElmNo Xpos Ypos MTX3 MTX5-D (Memory UniqueId (Element (X Position) (Y Position) Number) Number) 512 30001 0 0-5 0-2 o (STIN1L- (0:Band A 3R) 1:Band B o 2:Band C) 0 o PrmNo (Parameter Number) 0 IndexNo Category (Index Number) 0 3BAND EQ 1 0 0 2 0 Prarameter Name PEQ 6 Channel 3 Band PEQ MIN Q(*) 63.0 MAX unit 0.1 - Frequency 20.0(*) 20.0k Hz 0 Gain(*) -18.0 18.
7.
7. Parameter List Model Access ID MemNo ElmNo PrmNo IndexNo Category Prarameter Name Xpos Ypos MTX3 MTX5-D (Memory UniqueId (Element (Parameter (Index (X Position) (Y Position) Number) Number) Number) Number) 512 20008 0 0-3 0 0 0 EFFECT ST Fader 4 Fader o (Fx.
7.
7. Parameter List Model Access ID MemNo ElmNo PrmNo IndexNo Category Xpos Ypos MTX3 MTX5-D (Memory UniqueId (Element (Parameter (Index (X Position) (Y Position) Number) Number) Number) Number) 512 20014 0 0-7 0 0 0 ZONE ANC o (ZONE1-8) 20021 o 20014 1 o o o o o 1 0 o o o o o o 1 o o 2 o 60003 0 o 1 o o o 2 o o o 70001 0 70005 20016 1 o o 20023 20017 0 o o 1 o o o o o 70002 0 70006 20018 0 o o 20025 20018 0 o o dB x 100 ex.-73.60dB x 100 = -7360 Threshold -∞ 0.
7. Parameter List Model Access ID MemNo ElmNo Xpos Ypos MTX3 MTX5-D (Memory UniqueId (Element (X Position) (Y Position) Number) Number) 512 20019 0 0-7 0-3 (OUT1-8) (0:Band A 1:Band B o 2:Band C 3:Band D) 20026 0-15 o (OUT1-16) 20019 0 0-7 o (OUT1-8) o o o o o o o o o o o o o o o o o o o 1 0 2 Prarameter Name PEQ 8(16) Channel 4 Band PEQ MIN Q(*) 63.0 MAX unit Remarks 0.1 - * See "2.3BAND EQ / 4 BAND EQ" in "7. Parameter Values" Frequency 20.0(*) 20.0k Hz 0 Gain(*) -18.
7.
7.
7.
7.
7.
7.
7. Parameter List EXi8 Access ID MemNo ElmNo PrmNo IndexNo Xpos Ypos (Memory UniqueId (Element (Parameter (Index (X Position) (Y Position) Number) Number) Number) Number) 512 1 3 0 to 7 0 0 0 1 Prarameter Name MIN Signal GAIN Processing +V48 MAX unit -6 OFF 66 ON dB - 2 Phase OFF ON - 3 On OFF ON - 4 HPFOn OFF ON - 5 HPFFrequency 20 20000 Hz MTX3/MTX5-D/XMV Series/EXi8/EXo8 Remote Control Protocol Specifications V1.0.
7. Parameter List EXo8 Access ID MemNo ElmNo PrmNo IndexNo Xpos Ypos (Memory UniqueId (Element (Parameter (Index (X Position) (Y Position) Number) Number) Number) Number) 512 1 3 0 to 7 0 0 0 1 2 Prarameter Name Signal Polarity Processing On Gain MIN MAX Normal Inverse - OFF ON - -96 24 dB MTX3/MTX5-D/XMV Series/EXi8/EXo8 Remote Control Protocol Specifications V1.0.3 unit Remarks 0:Normal 1:Inverse 0:OFF 1:ON dB x 10 ex. -14.
7.
8.
8.
8. Meter List Model MTX3 o Access ID MemNo Category MTX5-D (Memory UniqueId Number) 512 OUTPUT CHANNEL 20020 o o o OUTPUT PORT OUTPUT (ANALOG) 20031 20032 90000 o OUTPUT CHANNEL 20027 20025 o Meter Name OUTPUT (SLOT) MY4-AEC Meter 8 Channel (OUTPUT CH1-8) Meter 16 Channel (OUTPUT CH1-16) Meter 8 Channel (OUTPUT CH1-8) Meter 8 Channel (OUTPUT CH1-8) Meter 16 Channel (SLOT IN 1-16) MY4-AEC (Mic In. 1-4 Ref In. 1-4 Echo Attn. 1-4 ERL 1-4 PTT Thesh.
8. Meter List XMV Series Model 4ch 8ch o 4ch D 8ch D o o o Category Meter Name INPUT o 20001 o o Access ID MemNo (Memory UniqueId Number) 512 20000 - o - OUTPUT Meter 4 Channel (ANALOG INPUT A-D, DIGITAL INPUT A-D) Meter 8 Channel (ANALOG INPUT A-H, DIGITAL INPUT A-H) Meter 4 Channel (OUTPUT A-D) Meter 8 Channel (OUTPUT A-H) MTX3/MTX5-D/XMV Series/EXi8/EXo8 Remote Control Protocol Specifications V1.0.3 Type level Remarks See 6. Parameter Value Details.
8. Meter List EXi8 Access ID MemNo UniqueId (Memory Number) 512 20000 Category - Meter Name INPUT Meter 8 Channel (INPUT1-8) Type level MTX3/MTX5-D/XMV Series/EXi8/EXo8 Remote Control Protocol Specifications V1.0.3 Remarks See Parameter Value Details.
8. Meter List EXo8 Access ID MemNo UniqueId (Memory Number) 512 20001 Category - Meter Name OUTPUT Meter 8 Channel (OUTPUT1-8) Type level MTX3/MTX5-D/XMV Series/EXi8/EXo8 Remote Control Protocol Specifications V1.0.3 Remarks See Parameter Value Details.
