Driver Details

Yamaha MTX

By: RTI
Updated: June 15, 2018
Version: 1.0

Description:

This driver is for the Yamaha MTX3 and/or MTX5-D Matrix Processors using serial or Ethernet connectivity.

Please Note: This driver is NOT for use with the Yamaha MRX7-D Matrix Processor

Yamaha MTX

This driver is for the Yamaha MTX3 and/or MTX5-D Matrix Processors using serial or Ethernet connectivity.

!!! This driver is NOT for use with the Yamaha MRX7-D Matrix Processor !!!

Revision History

1.0 Initial release.

Connection Settings

Connection Type - Select the type of connectivity to use for communicating to the MTX Processor. The choices are Serial (RS-232) and Network (TCP).

Serial Settings

Serial Port - Select the Serial Port on the XP processor that is connected to the Yamaha MTX Processor. A null modem is required for serial communications between the XP/RJS-232 serial adapter and the MTX Processor.

Baud Rate - Select the Baud Rate the Yamaha MTX Processor is set to use from the MTX Editor software. The choices are 38400 and 115200.

Network Settings

IP Address - Enter the IP address assigned to the Yamaha MTX Processor.

IP Port - Enter the IP Port used for communicating to the MTX Processor. The default port is 49280.

Device Settings

Model - Select the model of the Yamaha MTX Processor. The choices are MTX3 and MTX5-D. Failure to set this field properly WILL result in an inoperable system.

Controller Configuration

Room Count - Enter the number of rooms to be used for room volume/on/off control. Up to 32 rooms are supported. Room configurations should be used only for the final volume adjustment available in a room and the On/Off state where applicable will automatically be combined with the volume.

All volume/on/off controls configured for Room control shall NOT be used in the Gain/Fader or State/Button section of the driver.

*Note - ID APEX uses the Room objects for the Auto-Programming of the "Room" volume and mute control.

Gain/Fader Count - Enter the number of Gain/Faders to be used. Up to 256 Gain/Fader objects are supported. The Gain/Fader section of the driver shall NOT include those which are configured in the Room section.

State/Button Count - Enter the number of State/Buttons to be used. Up to 256 Button/State objects are supported. The Button/State section of the driver shall NOT include those which are configured in the Room section.

Preset/Snapshot Count - Enter the number of Preset/Snapshots configured in the system. Up to 50 presets are currently supported.

Room Control Configurations 1-32

Name - Enter the Name to use for the Room Control. This name will be used throughout the driver and through UI programming.

Control Type - Select the type of control to be used for the room. Only the available selections may be used for Room Control so plan accordingly. The selections available are as follows:

Volume w/Phase Invert - I/O - Output

Volume w/On-Off - Main - Output

Volume w/On-Off - Zone - Output

Volume - Matrix - Output

Control ID - Enter the Control ID (Channel) of the volume output from the Yamaha MTX Editor software. The selections that have corresponding states (Phase Invert or On-Off) will automatically be mapped accordingly.

Gain/Fader Control Configurations 1-256

Name - Enter the Name to use for the Gain/Fader Control. This name will be used throughout the driver and through UI programming.

Control Type - Select the type of control to be used for the gain/fader. In addition to the pre-defined selections, a General Gain/Fader option is available. The selections are as follows:

Volume - I/O - Input

Volume - I/O - Output

Volume - Main - Input - Mono Only

Volume - Main - Input - Stereo L/R

Volume - Main - Input - FX Return

Volume - Main - Output

Volume - Zone - Output

Volume - Matrix - Input

Volume - Matrix - Output

Level - Input - D.Gain - Mono Only

Level - Input - Stereo D.Gain - Left or Right

Level - General Gain/Fader

*Note - The General Gain/Fader selection requires advanced knowledge of the MTX3 and/or MTX5-D along with access to the Yamaha MTX_MRX Protocol Documentation.

Control ID - Where Applicable - Enter the Control ID (Channel) of the gain/fader from the Yamaha MTX Editor software.

Control Output ID - Where Applicable - Enter the Control ID (Channel) of the gain/fader output from the Yamaha MTX Editor software.

Control Input ID - Where Applicable - Enter the Control ID (Channel) of the gain/fader input from the Yamaha MTX Editor software.

Control Left ID - Where Applicable - Enter the Control ID (Channel) of the gain/fader left channel from the Yamaha MTX Editor software.

Control Right ID - Where Applicable - Enter the Control ID (Channel) of the gain/fader right channel from the Yamaha MTX Editor software.

Unique ID - Where Applicable - Enter the Unique ID for the gain/fader from the Yamaha MTX_MRX Protocol Documentation.

Element - Where Applicable - Enter the Element Value for the gain/fader from the Yamaha MTX_MRX Protocol Documentation.

Parameter - Where Applicable - Enter the Parameter Value for the gain/fader from the Yamaha MTX_MRX Protocol Documentation.

X Position - Where Applicable - Enter the X Position for the gain/fader from the Yamaha MTX_MRX Protocol Documentation.

Y Position - Where Applicable - Enter the Y Position for the gain/fader from the Yamaha MTX_MRX Protocol Documentation.

State Configurations 1-256

Name - Enter the Name to use for the State/Button Control. This name will be used throughout the driver and through UI programming.

Control Type - Select the type of control to be used for the state/button. In addition to the pre-defined selections, a General State option is available. The selections are as follows:

Phantom Power - I/O - Input

Phase Invert - I/O - Output

Phase Invert - Input - D.Gain - Mono Only

On-Off - Main - Input - Mono Only

On-Off - Main - Input - Stereo L/R

On-Off - Main - Input - FX Return

On-Off - Main - Output

On-Off - Zone - Output

On-Off - Matrix - Input

On/Off - General State

*Note - The General State/Button selection requires advanced knowledge of the MTX3 and/or MTX5-D along with access to the Yamaha MTX_MRX Protocol Documentation.

Control ID - Where Applicable - Enter the Control ID (Channel) of the state/button from the Yamaha MTX Editor software.

Control Output ID - Where Applicable - Enter the Control ID (Channel) of the state/button output from the Yamaha MTX Editor software.

Control Input ID - Where Applicable - Enter the Control ID (Channel) of the state/button input from the Yamaha MTX Editor software.

Control Left ID - Where Applicable - Enter the Control ID (Channel) of the state/button left channel from the Yamaha MTX Editor software.

Control Right ID - Where Applicable - Enter the Control ID (Channel) of the state/button right channel from the Yamaha MTX Editor software.

Unique ID - Where Applicable - Enter the Unique ID for the state/button from the Yamaha MTX_MRX Protocol Documentation.

Element - Where Applicable - Enter the Element Value for the state/button from the Yamaha MTX_MRX Protocol Documentation.

Parameter - Where Applicable - Enter the Parameter Value for the state/button from the Yamaha MTX_MRX Protocol Documentation.

X Position - Where Applicable - Enter the X Position for the state/button from the Yamaha MTX_MRX Protocol Documentation.

Y Position - Where Applicable - Enter the Y Position for the state/button from the Yamaha MTX_MRX Protocol Documentation.

Preset/Snapshot Settings

Preset/Snapshot (1-50) Name - Enter the name to use for the Preset/Snapshot.

Driver Notes

- The driver uses a mechanism to see what run mode is active on the MTX Processor. Only a "Normal" run mode is allowed for driver communications. If the MTX Processor is not in a "Normal" run mode, the driver will not communicate to the MTX Processor other than asking for an update to the run mode. Once the MTX Processor reports it is in a "Normal" run mode, the driver will commence with an initialization process and once that is finished will allow for control of the system.

- Only the items required for RTI access are required to be configured, meaning if only 2 outputs are required in a project, only the 2 outputs need to be configured.

- The driver uses a 0-100% scale at a .1% precision for adjusting all Room Volumes and Gain Faders. A supplemental variable for Level dB (String) is available for all levels so that the appropriate value can be displayed as text on the UI. The General Gain/Fader variable for Level db. (String) will not append the dB text at the end of the text string as it may not be for a value in dB.

- Preset/Snapshot - Last Active feedback is only available once a preset is recalled and is not populated upon driver initialization.

- When any Preset/Snapshot is recalled, the driver will start a polling process to acquire all updated information as the MTX Processor does not automatically send the values that may have changed.

- Commands and variables are provided for the built in SD Card Player. Currently there is no browsing of the SD Card contents. To play a file, knowledge of the file structure on the SD Card is required and the Play File command must be issued to play the specified file. While the MTX Processor reports that it is in a "Play" or "Pause" state, the driver will poll the current song information every 5 seconds. It is possible and likely that a song may change and take up to 5 seconds for the feedback to change for the current song information.

- A RAW Command String is included for any commands not provided in the driver through any of the pre-defined selections or the General Gain/Fader and General State/Button selections. Feedback for RAW Commands is not available unless the feedback falls under the standard parsing routines in the driver. When issuing RAW Command Strings, the command termination must be omitted as the driver will automatically append any termination requirements to the command before sending it to the MTX Processor.

!!! This driver is NOT for use with the Yamaha MRX7-D Matrix Processor !!!