MMS Control4 Driver Programming Guide

Quick Start

Apple Music and Calm Radio require an eSeries or M Series MMS and an AMB-1 in the system.

Matrix Mode on M Series devices is not currently supported. Please be sure the system is not in Matrix Mode before continuing. Visit the System tab of the device’s configuration page (http://IPOfMMS/Config/System.html) to confirm. Non-Matrix Mode is the default.

If configuring both eSeries or M Series servers and eSeries amps, please ensure that the set of amps is on a different system ID than the group of servers. This can be accomplished on the System tab of an MMS’ configuration page and the Amplifier tab of an amplifier’s configuration page.

To quickly setup a system, follow these steps:

  1. Add the MCP driver for your specific model (MMS-5A, MMS-2A, MMS-1e, MMS-3e, MMS-5e, M3, or M5 Pro) to the system.

  2. Enter the target MMS' IP address in the IP Address field in MCP.

  3. Add Instance drivers for the outputs you’d like to use in the Control4 environment. Do this by pressing the Add All Instances button on the Actions tab in MCP. Be sure to use the Instance driver appropriate to the SKU being integrated. eSeries and M Series devices should use the eSeries Instance drivers. A Series devices should use the A Series Instance drivers.

    1. For A Series integrations, ensure that the Instance drivers are bound properly according to the Configuration section below

    2. In each Instance driver, ensure the target output is selected from the MMS Instance dropdown. This should be automatically configured.

    3. Bind the either audio output of your choice from each Instance driver to the audio distribution OR bind the eAudioCast binding to an eAudio input on the eSeries Amp driver (these should autobind).

  4. Add Streaming Service drivers to your client’s needs.

  5. Under the Actions tab in MCP, click Configure MMS.

Overview

The Autonomic Control4 Version 6 driver suite allows for convenient programming of all models of the Mirage Media Server (MMS) in a Control4 environment. The driver suite is compatible with systems running at least Control4 OS 3.3.0 or higher and MMS firmware 5.3 or higher. eSeries MMSes require firmware 6.0.20170328.0 or higher. M Series MMSes are supported at release, firmware 8.0+.

Autonomic Mirage Media Servers offer up to six audio outputs (MMS-5A) each with full access to local and internet based content such as Apple Music, Calm Radio, Deezer, iHeartRadio, Murfie, Napster, Pandora, Audacy, Rhapsody, SiriusXM, Slacker Radio, SoundMachine, Spotify, TIDAL, and TuneIn Radio, bridging them together with revolutionary TuneBridge™ functionality. Each output of the server is fully and discretely controllable.

This driver suite was developed and tested with Control4 3.3.0 running on EA series Directors and several control interfaces, including Control4’s iPad app and portable touch panels.

Features

Version 6 of the MMS driver suite integrates fully into the Control4 system. It offers individual drivers for each of the streaming services (Apple Music, Calm Radio, Deezer, iHeartRadio, Murfie, Napster, Pandora, Audacy, Rhapsody, SiriusXM, Slacker Radio, SoundMachine, Spotify, TIDAL, and TuneIn Radio) as well as a full browser for all content, local and streaming.  Both the individual drivers and full browser provide access to the complete MMS feature set including TuneBridge™, playlists, favorites, and queue management.   

Each service driver will automatically select an output on the server for use. Additionally, there is a central driver called MCP and a driver for Instances.

How the drivers communicate

This suite of drivers works by connecting the data of the Control4 Rooms to the MMS. While each service and Instance driver connects to the MMS for browsing and now playing control respectively, the MCP driver handles all major communication with the MMS. The service and Instance drivers communicate with each other through the MCP driver.

Getting Started

The Autonomic Control4 Version 6 driver suite for all models of the Mirage Media Server (MMS) is compatible with systems running at least Control4 OS 3.3.0 or higher and MMS firmware 5.3 or higher. eSeries MMSes require firmware 6.0.20170328.0 or higher. M Series MMSes are supported at release, firmware 8.0+.

Please verify that you are running the latest version of Composer and the Mirage Media Server firmware is up to date before proceeding.  

You can check and update your firmware version on the MMS by going to the Firmware tab on the server’s web configuration—http://IPOfMMS/config/Software.aspx for A Series or http://IPOfMMS/Config/System.html for eSeries and M Series—or from the Autonomic Dealer Zone company account associated with the MMS (http://dealerzone.autonomic-controls.com).  

The latest Composer software is available from Control4’s dealer site (https://dealer.control4.com).   

Configuration

Adding the drivers to your program

  1. In Composer, in the System Design section, select the Search tab on the far right. Next, search for Autonomic and/or Mirage in the search field. All of our driver’s should appear in the results list.

  2. Before adding other drivers, the central driver, called MCP for Mirage Media Server, needs to be added to the project. If multiple, discrete MMS systems are needed, adding multiple MCP drivers is supported as long as each driver has a different Control Port setting.

  3. Add the Instance drivers, called Instance for Mirage Media Server. This can be automatically accomplished by pressing Add All Instances under the Actions tab for the MCP driver. Add one copy of the Instance driver per Instance you'd like to include in your project. These drivers will automatically bind to the MCP driver as RF_AUTONOMICNET_INSTANCE bindings starting at the top of the output bindings. We recommend adding one Instance driver per output on your MMS and setting those you will not use to disabled. By default, the Instance drivers ‘Properties’ ‘MMS Instance’ is set to Player_A, so make sure you set each Instance driver to the appropriate value. Ensure that the Instance drivers are bound to the same RF_AUTONOMICNET_INSTANCE position as what physically matches the server (Main = 1, Player_A = 2, etc.). 

  4. Add drivers for the streaming services for accounts that your client has. These drivers are called [Service name] for Mirage Media Server and they will automatically bind to the MCP driver starting at the top of the input bindings as RF_AUTONOMICNET_SERVICE.

Binding the drivers to the rest of the system

Each Instance driver has several output types, but only one should be bound. The choice of TOSLINK S/PDIF, coax S/PDIF, or an RCA pair allows the same driver to be used for all possible MMS output types. Bind the audio output type that matches the physical output on the MMS for the Instance the driver is controlling to the input on the switch that the MMS output is physically wired to. For example, if the driver is representing the Main output on an MMS-5A or MMS-2A, bind the coax S/PDIF output to the switch whereas if it’s representing Player_A on any model MMS, bind the RCA pair. Previous generation MMSes should use the TOSLINK S/PDIF output for their Main outputs. 

Configuring the drivers

Only the MCP driver needs the IP of the MMS. This will auto populate if the MCP driver was added through SDDP discovery. If the driver was added manually or the IP did not auto populate, select the MCP driver under System Design and enter the IP of the MMS you’d like to control. MCP will communicate this information to the other drivers. Each Instance driver needs to know which Instance it represents. It’s very important to press the Update Rooms button after making any change to a Room. Adding, removing, changing the name of, or changing the available devices in a Room without pressing Update Rooms will cause the MMS to get out of sync with the current settings.

Configuring the MMS

  1. Once all drivers are in place and connections bound, select the MCP driver under System Design.

  2. Select the Actions tab, then click Configure MMS. The driver will connect to the MMS and configure it to match your program.

Hiding Drivers

It is possible to hide the Instance drivers from the navigators. We only recommend hiding Instance drivers in navigators when all Instances are available in all rooms.

  1. Select the room under System Design

  2. Select the Navigator tab

  3. Double-click on the Music option under Menu

  4. Move drivers to the hidden side of the window that pops up.

 

For advanced users: If an MMS output has a valid audio path to multiple rooms, but it is desired to play specifically in one room and none others, hiding this Instance driver in all rooms but the room where it will be available will accomplish this.

Properties

MCP

IP address - the address of the MMS being controlled. This auto populates when the driver is added through SDDP.

Status - the status of the IP connection to the server

Configuration Status - whether or not the driver has configured the server since the last Control4 program change involving these drivers

Coax Bit Rate Format - the bit depth and sample rate the MMS' digital output should use, available in A Series compatible drivers only

Debug Mode - Turns Lua debugging on or off

Amplifier Module Detected – the status of the connection with the bound Autonomic amplifier driver, if connected

Instance

MMS Instance - Sets which output on the server the driver represents and controls

Enabled - Enables the Instance

Debug Mode - Turns Lua debugging on or off

Service Drivers

Debug Mode - Turns Lua debugging on or off

Favorite 

A favorite is any playlist, queue or radio station playing from any local library or online streaming music service account. A user can store favorites for instant recall through the Autonomic TuneBridge functionality while the content is currently playing. To save a favorite to the MMS library select the TuneBridge icon, then "Create a Snapshot in Autonomic Favorites" from the menu list. The favorite will then be available for playback under the "Favorites" tab on the MMS.

Favorite Drivers

Displays all favorites saved on the MMS. Favorites can be accessed directly from the favorites driver. Favorites can also be linked to actions in the programing section under a specific room, they will appear as a broadcast audio item when browsing for media.

Actions

Configure MMS

This action interrogates the room layout and configured drivers automatically and then informs the MCP server of the available outputs based on the drivers present in the Control4 program.  

Limitations

Workflows that require a series of text input boxes are not supported due to the inability to asynchronously request a keyboard. Additionally, as message boxes are added or changed, drivers will have to be updated.

Troubleshooting

Playing content is not heard in Room

Check that each Instance driver has the correct MMS Instance selected. Incorrectly configuring the Instances can cause the wrong input on the audio switch to be selected. Also, confirm that the server is configured properly by clicking the Configure MMS action on the Actions tab for the MCP driver in System Design.

Service drivers cannot browse

Ensure that MCP has the correct IP address. This value is communicated to all other drivers. If it is incorrect, those drivers will not be able to communicate with the MMS. If the issue persists, turn Lua logging on for the Service driver in question and try to browse. If the logs show a failure to communicate, there may have been a miscommunication between drivers. Re-enter the IP address into MCP to force the correct value.

Technical Support

If you require further assistance with configuring the drivers, please contact Autonomic Technical Support at 914-598-1647, option 2 or email support@autonomic-controls.com. You can also browse the rest of our Knowledge Base for troubleshooting information and access to submitting a support ticket.