User Manual

ManualsBrandsYamaha ManualsUnified CommunicationsRemote Conference Processor

Table Of Contents

RM Series (RM-CR/RM-CG) Remote Control Protocol Specifications

RM Series (RM-CR/RM-CG)

Remote Control Protocol Specications

Version 1.0.0 rev1

This specication document applies to RM-CR/RM-CG V1.0.1 and later.

Summary of content (51 pages)

PAGE 1
RM Series (RM-CR/RM-CG) Remote Control Protocol Specifications Version 1.0.0 rev1 This specification document applies to RM-CR/RM-CG V1.0.1 and later.
PAGE 2
Table of contents 0. Revision History............................................................................................................................... 4 1. Setup................................................................................................................................................. 5 1.1. Connection Procedure.................................................................................................................................................... 5 1.2.
PAGE 3
Table of contents 6. Parameter Value Details................................................................................................................ 29 6.1. Fader parameter........................................................................................................................................................... 29 6.1.1. Fader with "-Infinity to 0dB" range.................................................................................................................... 29 6.2.
PAGE 4
0. Revision History Version V1.0.0 Date Jan. 31, 2021 Section - Description Initial version RM Series (RM-CR/RM-CG) Remote Control Protocol Specifications Version 1.0.
PAGE 5
1. Setup 1.1. Connection Procedure Remote Controller Ethernet Network Switch Ethernet Dante conector VXL1-16P 1.2. Configuring the Remote Controller RM-CR/CG can be controlled from an external controller through the Ethernet (Dante) connector The configuration on the remote controller side for each type of connection is shown below. Ethernet (NETWORK connector) control IP Address: Specify the IP address of the RM-CR/CG IP Port No.: 49280 1.3.
PAGE 6
2. Command List 2.1. Commands from a device sent to a remote controller No.
PAGE 7
3. Command Specifications 3.1. Basic Command Specifications Below is the syntax of commands exchanged between a device and remote controller.
PAGE 8
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 NOTIFY devstatus Example: Option 1 runmode runmode Option 2 "normal" "update" Description Normal run mode Update mode Notification: NOTIFY devstatus runmode "normal" Meaning: The run mode was changed to normal mode.
PAGE 9
3. Command Specifications 3.2.4. Event processing change notification 1-5) Alert notification Command NOTIFY event Example: Option 1 Option 2 “: ,” RM:Alert Description : Alert number (Hex) :Alert message :warning/error/fault Notification: NOTIFY event RM:Alert “01:SYSTEM ERROR,fault” Meaning: Fault type 01 SYSTEM ERROR alert occurs 3.3. Commands for controlling a device 3.3.1.
PAGE 10
3. Command Specifications 3.3.2.
PAGE 11
3. Command Specifications 2-6) Keepalive activation setting Command scpmode Option 1 keepalive Option 2 (interval) Details: (interval) = Timeout value (msec) Description Maximum interval for a client to send some kind of message, including heart beats (default setting = disabled) * Timeout value should be more than 1000. * The actual timeout value will be increased by 1 second.
PAGE 12
3. Command Specifications 2-8) Normalized value parameter query Command getn Details: Option 1 AccessID Option 2 X Option 3 Y Description Normalized value parameter query request AccessID = See section 7, "Parameter List." X = See section 7, "Parameter List." Y = See section 7, "Parameter List.
PAGE 13
3. Command Specifications 2-10) Normalized value parameter setting Command setn Details: Option 1 AccessID AccessID = X= Y= (value) = Option 2 X Option 3 Y Option 4 (value) Description Normalized value parameter setting See section 7, "Parameter List." See section 7, "Parameter List." See section 7, "Parameter List." See section 3.1, "Basic Command Specifications," or section 7, "Parameter List." * When value is set "1023" (default:1000), control resolution becomes same as "Raw value" command.
PAGE 14
3. Command Specifications 2-12) Stop request mtrstop Command Option 1 MeterId Description Requests that the specified meter data be stopped. Details: MeterId = See section 8, "Meter List." Response Response string Description Meter data stop setting complete OK mtrstop MeterId Details: MeterId = See section 8, "Meter List." Example: Command: Response: Meaning: mtrstop RM:FeInPostFader OK mtrstop RM:FeInPostFader Stop the meter data of ch1 to 8 of FarEnd inputs.
PAGE 15
3. Command Specifications 3-3) Firmware version query Command Option 1 version devinfo Description Queries the firmware version Response Response string OK devinfo version "xxxx" Details: Description Firmware version xxxx = Version Example: Command: Response: Meaning: devinfo version OK devinfo version "1.0.0" Query the firmware version. Firmware version = V1.
PAGE 16
3. Command Specifications 3-7) Device ID query Command Option 1 deviceid devinfo Description Queries the device ID Response Response string OK devinfo deviceid "xxxx" Description Device ID Details: xxxx = Device ID * 3-digit hexadecimal Example: Command: Response: Meaning: Note: devinfo deviceid OK devinfo deviceid "001" Query the device ID. Device ID = "001" The device ID corresponds to the UNIT ID.
PAGE 17
3. Command Specifications 3.4.2.
PAGE 18
3. Command Specifications Parameter type integer freq Integer Frequency binary Hexadecimal string String An integer value that can be handled within the range of Min to Max value. Frequency values that specify the correspondence between actual values and values that handled by users according to ISO-266 standard. This is not Min or Max value, it's the parameters that are treated as hexadecimal numbers of up to 4 bytes. In this type, the operation of setn, setr, getn is not guaranteed.
PAGE 19
3. Command Specifications 3-13) Structure of meter query Command Option 1 index mtrinfo Description Queries the meter structure Response Response string OK mtrinfo Description Device Label Details) Index index Meter address address Integer Alphabet Data number Data type Integer Alphabet num type Index value when request Meter address string The address specifications depend on the specifications of the device to be operated.
PAGE 20
3. Command Specifications Event List Applicable devices RM-CR RM-CG (only work No.1 -16 commands) Usage example(s) event … ↓ OK event ... event No. Case Action EventID RM:FirmwareUpdate “” Data 1 Update request event string : update data source path (e.g.
PAGE 21
3. Command Specifications No. Case Action EventID Data 34 Setting change notification NOTIFY event rm:changedcallconfig “(attribute)=(value)” string Attribute/value settings are content of No.
PAGE 22
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. In the normal processing state, remote control is realized by combining various commands according to the specifications of the controller.
PAGE 23
4. Command Sequence 4.1. 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. • If an Ethernet connection is required, the remote controller needs to establish a logical session.
PAGE 24
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.
PAGE 25
4. Command Sequence 4.2. 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.
PAGE 26
4. Command Sequence Applying the most recent status of the controller to the device Remote controller Controlled device Running normally Connection detection Apply Running normally Communication possible set RM:ExtMic_Fader/Ch/Level 0 0 -775 OK set RM:ExtMic_Fader/Ch/Level 0 0 -775 "-7.75" set XXX/XXXXX/X/X/X/X/X X X XXXX Apply OK set XXX/XXXXX/X/X/X/X/X X X XXXX "XXXX" set XXX/XXXXX/X/X/X/X/X X X XXXX Apply OK set XXX/XXXXX/X/X/X/X/X X X XXXX "XXXX" ......
PAGE 27
4. Command Sequence 4.4. 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.
PAGE 28
5. Meter Value 5.1. Level Meter, Hold Meter, GR Meter 5.1.1.
PAGE 29
6. Parameter Value Details 6.1. Fader parameter 6.1.1. Fader with "-Infinity to 0dB" range 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 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 58 59 60 61 62 63 Data -InfdB -138.00dB -136.00dB -134.00dB -133.00dB -132.00dB -131.00dB -130.00dB -129.00dB -128.00dB -127.00dB -126.00dB -125.00dB -124.00dB -123.00dB -122.00dB -121.00dB -120.00dB -119.00dB -118.00dB -117.00dB -116.00dB -115.
PAGE 30
6. Parameter Value Details Value 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 Data -25.55dB -25.50dB -25.45dB -25.40dB -25.35dB -25.30dB -25.25dB -25.20dB -25.15dB -25.10dB -25.05dB -25.00dB -24.95dB -24.90dB -24.85dB -24.80dB -24.75dB -24.70dB -24.65dB -24.60dB -24.55dB -24.50dB -24.45dB -24.
PAGE 31
6. Parameter Value Details 6.2. DRC 6.2.1. Ratio value Display 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 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 value 1.0:1 1.1:1 1.2:1 1.3:1 1.4:1 1.5:1 1.6:1 1.7:1 1.8:1 1.9:1 2.0:1 2.1:1 2.2:1 2.3:1 2.4:1 2.5:1 2.6:1 2.7:1 2.8:1 2.9:1 3.0:1 3.1:1 3.2:1 3.3:1 3.4:1 3.5:1 3.6:1 3.7:1 3.8:1 3.9:1 4.0:1 4.1:1 4.2:1 4.3:1 4.4:1 4.5:1 4.6:1 4.7:1 4.8:1 4.9:1 5.0:1 5.1:1 5.2:1 5.3:1 5.4:1 5.5:1 5.6:1 5.
PAGE 32
6. Parameter Value Details 6.2.2.
PAGE 33
6. Parameter Value Details 6.2.3. Hold value 2 4 7 9 11 14 16 18 21 23 25 27 29 31 34 36 39 41 43 45 47 49 52 54 56 58 60 62 65 67 69 72 75 80 84 88 93 97 102 106 110 115 119 123 128 132 136 143 149 158 167 175 184 193 Display 0.02msec 0.04msec 0.07msec 0.09msec 0.11msec 0.14msec 0.16msec 0.18msec 0.21msec 0.23msec 0.25msec 0.27msec 0.29msec 0.31msec 0.34msec 0.36msec 0.39msec 0.41msec 0.43msec 0.45msec 0.47msec 0.49msec 0.52msec 0.54msec 0.56msec 0.58msec 0.60msec 0.62msec 0.65msec 0.67msec 0.69msec 0.
PAGE 34
6. Parameter Value Details 6.3. InputVolume 6.3.1. Level In the case of using setn with SCP resolution of 1024 value Display -32768 -INFINITY -13800 -138.00 -13600 -136.00 -13400 -134.00 -13300 -133.00 -13200 -132.00 -13100 -131.00 -13000 -130.00 -12900 -129.00 -12800 -128.00 -12700 -127.00 -12600 -126.00 -12500 -125.00 -12400 -124.00 -12300 -123.00 -12200 -122.00 -12100 -121.00 -12000 -120.00 -11900 -119.00 -11800 -118.00 -11700 -117.00 -11600 -116.00 -11500 -115.00 -11400 -114.00 -11300 -113.
PAGE 35
6. Parameter Value Details value -3760 -3750 -3740 -3730 -3720 -3710 -3700 -3690 -3680 -3670 -3660 -3650 -3640 -3630 -3620 -3610 -3600 -3590 -3580 -3570 -3560 -3550 -3540 -3530 -3520 -3510 -3500 -3490 -3480 -3470 -3460 -3450 -3440 -3430 -3420 -3410 -3400 -3390 -3380 -3370 -3360 -3350 -3340 -3330 -3320 -3310 -3300 -3290 -3280 -3270 -3260 -3250 -3240 -3230 -3220 -3210 -3200 -3190 -3180 -3170 -3160 -3150 -3140 Display -37.60 -37.50 -37.40 -37.30 -37.20 -37.10 -37.00 -36.90 -36.80 -36.70 -36.60 -36.50 -36.
PAGE 36
6. Parameter Value Details value -1490 -1485 -1480 -1475 -1470 -1465 -1460 -1455 -1450 -1445 -1440 -1435 -1430 -1425 -1420 -1415 -1410 -1405 -1400 -1395 -1390 -1385 -1380 -1375 -1370 -1365 -1360 -1355 -1350 -1345 -1340 -1335 -1330 -1325 -1320 -1315 -1310 -1305 -1300 -1295 -1290 -1285 -1280 -1275 -1270 -1265 -1260 -1255 -1250 -1245 Display -14.90 -14.85 -14.80 -14.75 -14.70 -14.65 -14.60 -14.55 -14.50 -14.45 -14.40 -14.35 -14.30 -14.25 -14.20 -14.15 -14.10 -14.05 -14.00 -13.95 -13.90 -13.85 -13.80 -13.
PAGE 37
6. Parameter Value Details 6.4. Ducker 6.4.1. Release Same as DRC Release See "6.2.2.Release" 6.4.2. Hold Same as DRC Hold See "6.2.3.Hold" 6.5. MasterVolume 6.5.1. Level Same as InputVolume Level See "6.3.1.Level" RM Series (RM-CR/RM-CG) Remote Control Protocol Specifications Version 1.0.
PAGE 38
6. Parameter Value Details 6.6. InputEQ 6.6.1. Frequency value 20000 20535 21135 21752 22387 23041 23714 24406 25119 25852 26607 27384 28184 29007 29854 30726 31623 32546 33497 34475 35481 36517 37584 38681 39811 40973 42170 43401 44668 45973 47315 48697 50119 51582 53088 54639 56234 57876 59566 61306 63096 64938 66834 68786 70795 72862 74989 77179 79433 Display 20.0 20.5 21.2 21.8 22.4 23.0 23.6 24.4 25.0 25.9 26.5 27.4 28.0 29.0 30.0 30.7 31.5 32.5 33.5 34.5 35.5 36.5 37.5 38.7 40.0 41.0 42.5 43.4 45.
PAGE 39
6. Parameter Value Details 6.6.2. Q value 100 105 110 120 125 130 140 150 160 170 180 190 200 210 220 240 250 270 280 300 320 330 350 380 400 420 450 470 500 Display 0.1 0.105 0.11 0.12 0.125 0.13 0.14 0.15 0.16 0.17 0.18 0.19 0.2 0.21 0.22 0.24 0.25 0.27 0.28 0.3 0.32 0.33 0.35 0.38 0.4 0.42 0.45 0.47 0.5 value 530 560 600 630 670 700 750 800 850 900 950 1000 1050 1100 1200 1250 1300 1400 1500 1600 1700 1800 1900 2000 2100 2200 2400 2500 2700 Display 0.53 0.56 0.6 0.63 0.67 0.7 0.75 0.8 0.85 0.9 0.95 1.
PAGE 40
7. Parameter List Parameter List Applicable devices RM-CR Usage example(s) set get NOTIFY No.
PAGE 41
7. Parameter List No. Case 12 FarEnd input fader enable 13 FarEnd input fader level setting Action set setn sett setr get getn gett Address RM: FeIn_Fader/Ch/On SubAddress 0-7 0-1: 0 Bluetooth Input L - R 2 - 3 : AUX ch1 - 2 4-5: SIP(VoIP)ch1 - 2 6 - 7 : USB L - R Parameter 0, 1 0 : OFF 1 : ON 0 1 1 RM: 0-7 0-1: 0 FeIn_Fader/Ch/Level Bluetooth Input L - R 2 - 3 : AUX ch1 - 2 4-5: SIP(VoIP)ch1 - 2 6 - 7 : USB L - R -32768 ... -32768 : -INFINITY -32768 1000 1000 -13800 : -138.0[dB] ... 0 : 0.
PAGE 42
7. Parameter List No. Case 30 Set time until compression is completed by mic input compressor after signal level crosses the threshold Action Address SubAddress Parameter RM: ExtMic_Comp/Ch/ Attack 0 - 1 0 - 1 : Mic ch1 - 2 0 0 ... 120 0 120 RM: ExtMic_Comp/Ch/ Release 0 - 1 0 - 1 : Mic ch1 - 2 0 3340 ... 3340 : 3.34[msec] 42700000 ... 42700000 : 42.
PAGE 43
7. Parameter List No. Case 51 Number of mic CH gates opened simultaneously by NearEnd input gain sharing automixer 52 NearEnd input gain sharing automixer priority mic setting Action set setn sett setr get getn gett Address SubAddress RM: 0 GainSharingAutomix/ Settings/ NumOfOpenMic RM: 0GainSharingAutomix/ 15 Ch/PriorityMic 0 - 15 : Dante In ch1 - 16 Parameter 0 1 ... 16 1 : 1ch ...
PAGE 44
7. Parameter List No. Case 69 RoomEQ band Q value setting Action Address SubAddress Parameter RM: 0 - 1 0 - 1 : Mic ch1 - 2 0 - 5 Band 1 - 6 RoomEQ/Ch/Band/Q 100 ... 16000 100 : 0.1 ... 16000 : 16.0 * See Q data table RM: RoomEQ/Ch/Band/ Type 0 - 1 0 - 1 : Mic ch1 - 2 0 - 5 Band 1 - 6 0 ... 6 0 : PEQ 0 1 : L.SHELF 6dB/Oct 2 : L.SHELF 12dB/Oct 3 : H.SHELF 6dB/Oct 4 : H.
PAGE 45
7. Parameter List No. Case Action Address SubAddress Parameter 83 SpeakerProcessor set PEQ band gain setting setn sett setr get getn gett 84 SpeakerProcessor RM: SpeakerProcessor/ Ch/PEQBand/Gain 0-3 0-1: Analog Speaker Output ch1 - 2 2-3: Dante Speaker Output ch1 - 2 0 - 5 Band 1 - 6 -1800 ... 1800 -1800 : -18.0[dB] ... 0 : 0.0[dB] ... 1800 : +18.
PAGE 46
7. Parameter List Parameter List Applicable devices RM-CG Usage example(s) set RM:Mic_Beam/LimitOn 0 0 1 ↓ OK set RM:Mic_Beam/LimitOn 0 0 1 "ON" get RM:Mic_Beam/LimitOn 0 0 ↓ OK get RM:Mic_Beam/LimitOn 0 0 1 NOTIFY set RM:Mic_Beam/LimitOn 0 0 1 "ON" set get NOTIFY No. Case 1 Mic input level setting 2 Beamforming area limit enable 3 Beamforming area top limit setting 4 Action set setn sett setr get getn gett Address SubAddress Parameter RM:DSPTOP/MicGaintype 0 0 0 ...
PAGE 47
7. Parameter List No. Case 20 Mic input AGC gain curve setting (AGC effectiveness increases as the value increases, but volume fluctuations feel stronger) Action Address SubAddress Parameter set setn sett setr 21 Mic input AGC response speed setting get (AGC response speed increases as the getn value increases, but volume fluctuations gett feel stronger) RM:Mic_Agc/Agctype 0 0 0 ...
PAGE 48
8. Meter List Applicable devices RM-CR Usage example(s) set get NOTIFY No.
PAGE 49
8. Meter List No. Case Action Address Meter Type Parameter 33 Compressor signal level meter data for mic input CH NOTIFY mtr RM:ExtMicCompOut level 0x00 - 0x7F meter level.
PAGE 50
8. Meter List Applicable devices RM-CG Usage example(s) set get NOTIFY No.
PAGE 51
9.