Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 2 Next »

Compatible Devices

Version History

Version

Date

Comments

2.4

12/23/24

Quick Start

To quickly setup a system, follow these steps:

  1. Add the core driver and the interface drivers for all the outputs you’d like to
    use in the URC Total Control environment.

  2. Enter the IP address of the MMS.

  3. Ensure that the drivers are bound properly according to the Configuration
    section below.
    a. The driver name specifies what output the driver is for.

Overview

The Autonomic URC module suite allows for convenient programming of all
models of the Mirage Media Server (MMS) in a URC Total Control 2.0/3.0 System
environment.
Autonomic Mirage Media Servers offer up to five audio outputs, each
with full access to local and internet-based content, bridging them together with revolutionary TuneBridge®
functionality. Each output of the server is fully and discretely controllable.

Features

Version of the MMS module suite integrates fully into the URC Total Control
2.0/3.0 System. It offers functionality for each of the streaming services as well as full access to all local and streaming content.
Each output in the module maps directly to the corresponding output on the
MMS server, making MMS outputs available for standard output configurations
in the URC environment. The MMS driver contains one-way commands which
can be mapped to buttons on URC clients, and also two-way user interfaces for
URC clients mentioned above. The one-way driver commands are capable of
functioning even while the MMS module is not running on the URC client.

Getting Started

The Autonomic URC module suite for all models of the MMS is compatible with
URC Total Control 2.0/3.0 System. Please verify that you are running the latest
version of URC Accelerator software and the Mirage Media Server firmware is up
to date before proceeding.
Check and update your firmware version on the MMS by going to the Firmware
tab on the server’s web configuration (at http://server-ip/config/System.html, http://server-ip/Config/Software.html or http://server-ip/config/Software.aspx depending on the MMS model), or from
the Autonomic Dealer Zone (http://dealerzone.autonomic-controls.com) company
account associated with the MMS.

Download

The latest URC Accelerator software is available from the URC Dealer Portal for
authorized URC dealers. If you’re not an authorized dealer, please contact URC:
https://www.urc-automation.com/support

All Mirage Media Servers control drivers are available for download on any of our
product pages at https://www.autonomic.biz under the “Documents” tab or at
https://autonomic.biz/support/ (login required).
To download the URC Module Suite, simply click on the link labeled
Autonomic URC Module to start the download of the zip file.

Details of Module Communication

The URC system controller handles all communication
with the MMS and is responsible for relaying client commands. Each URC
client device (remotes, keypads and mobile apps) is capable of independently
controlling all the audio outputs on the MMS. The MMS driver contains all the
outputs available on the server, which are capable of being mapped in the
URC environment to different rooms or inputs of another device.

Upgrading from a Previous Version

Upgrading from Version 1.x
Version 1.x of the MMS module was intended primarily for Accelerator
1 programmed systems. While it’s possible to use this version on systems
programmed with Accelerator 2 or 3 the graphics are not optimized for the
interface. The recommendation is to replace version 1.x with the latest available version.
Quick Upgrade from Version 2.0
In order to use all the updated features of the new version it’s important to
follow the below steps.

  1. Import I the new TCM

  2. Restart Accelerator

  3. Remove all interfaces of the URC module from the project tree

  4. Re-add the interfaces

  5. Configure inputs and outputs in “AV Inputs & Outputs” and/or “URC Audio
    Setup”/”DMS Setup”

  6. Re-Accelerate UI and Macros.

Configuration

REQUIREMENTS

• TCM file: contains one-way and two-way driver including client interfaces
• URC Accelerator software 2.0/3.0
• Total Control System Hardware
• Mirage Media Server

CONFIGURING THE TOTAL CONTROL SYSTEM IN THE URC
ACCELERATOR

Note: The following steps illustrate a basic configuration of URC Total Control
2.0/3.0 System for Autonomic MMS. For more details or advanced setups,
please refer to URC Documentation.

Import Module

Open the URC Accelerator software. Go to File tab > Import TCM Files. This
will open a browse dialog box. Navigate to the location where the .tcm file
is saved and click on Open to import the file.

[IMAGE]

Important: Please restart the URC Accelerator software by closing and re-launching it.

Basic Accelerator Setup

On relaunching the URC Accelerator software, set up a new project by
going to File tab > New follow the guided form to create a new project.

[IMAGE]

Click on Save to Project Tree.

Rooms

The Add Rooms tab will open under Program. Add additional rooms
depending on your setup.

[IMAGE]

URC Devices

Go to Add URC Devices. This is for adding the existing URC Total Control
devices. Select the room in the Current Room menu on the left. Double-click
on a device, or click on Add to Room button on top left to add a device.
For some devices, a dialog box opens up showing advanced settings for the
device. Unless advanced setup is needed, leave default options selected and
click on Apply.

[IMAGE]

Other Devices

Go to Add Other Devices.

  1. In the left pane under Select Room, select the desired room to add the
    device to.

  2. In Select Database, choose My.

  3. In Select Module Type, choose IP Database.

  4. In Select Category, choose Audio.

  5. In Select Brand pane, choose Autonomic.

  6. In Select Model pane, choose the player(s) you wish to add one at
    a time. Double-click on this, or highlight and click on Add Selected
    Modules button on top left to add it to the currently selected room.
    [IMAGE]
    Note: To edit the names of your added devices, right-click on the device >
    Rename. These are the names which show up in the menus and clients.

  7. In Select Model pane, choose the player(s) you wish to add one at a time
    i.e. MMS-1E PLAYER A. Double-click on this, or click on Add Selected
    Modules button on top left to add it to the currently selected room. In
    the following popup make sure the player added is associated with the
    correct MMS Core module.
    [IMAGE]

Network Setup

Go to Network Setup. This section configures both URC and non-URC
devices (in this case, Mirage Media Server) with the current network
address. As a prerequisite, ensure all the devices are on the network with
desired static or DHCP configuration.

  1. Click on tab URC Device. This will show all the currently added URC
    devices in the project in the left pane. In this pane, click on the device
    you want to configure the IP address for. Then click on the Refresh
    button. This might take a small amount of time, after which it will show
    you the discovered URC devices on the current network of currently
    selected type in the right pane. Pick the device in the right pane with
    the correct IP address. Then click on Assign button. If the devices are
    not discovered, please ensure the actual device is on the network and is
    switched on. Alternatively, you can also manually enter the MAC address
    and IP addresses of your devices in the left pane.
    [IMAGE]

  2. Click on tab Non URC Device. This will show all the currently added
    non-URC devices in the project in the left pane. If you previously added
    Mirage Media Server to a room, its instance(s) should show up in the
    left pane. Enter the IP Address for the MMS in the IP Address field. Port
    field should already be filled with value 5004.
    [IMAGE]

Direct service jumps (Optional)

Starting in version 2.3 a simplified method to launch directly to a specific
music service was introduced.

  1. To enable a menu button for a specific service Select Properties Manger,
    highlight the MMS Interface in the “Project Tree” and Select “Device
    Property” in the “Available Property” section.
    [IMAGE]

  2. In the Function List dropdown select the module to be enabled and
    check the box “Create device layout when generating menus and
    layouts “.

Adjusting Startup Parameters (Optional)

Starting in version 2.3 a new method to provide input parameters to the
module was introduced.

  1. To enable a menu button for a specific service Select Properties Manger,
    highlight the MMS Interface in the “Project Tree” and Select Module
    Parameters.

  2. In the Parameter panel adjust the property values (y/n) to customize the
    module experience.
    [Image]

  3. Depending on launching to a specific service, local music or the generic
    all services module, there are different options available. Below is a list
    of available parameters and where they are applicable.

Background art: (y/n) Default (y)
• On UIs supporting displaying background art this can optionally be
disabled.
Always browse on launch: (y/n) Default (n)
• By default, when opening the module if no music is directly available
for playback, the browsing screen will load. By enabling this option, the
module will always present the user with the top-level browse screen.
Local music available: (y/n) Default (y)
• For installations where the MMS does not have any locally indexed
music this option can be disabled.
• This option is not available for direct launch to a specific streaming
service.
Streaming Services available: (y/n) Default (y)
• When launching directly to Local Music enabling this option does not
show the Streaming menu in the options menu.
• Only available when directly launching to Local Music.
Browse back to other services: (y/n) Default (n)
•When launching to a specific service enabling this option will allow
the user to press back from the service’s top-level menu to the list of
services. When this is disabled pressing back on the service’s top-level
menu will return to the now playing screen.
Clear other services: (y/n) Default (n)
•When launching directly to a specific service or Local Music enabling this
option, stops playback of any other music service and clears the queue.
•Available for direct launch to a service or local music

Inputs and Outputs

Go to AV Inputs & Outputs tab. Click on the Inputs tab. Here, available
outputs of the MMS can be assigned to inputs of another device (only
if those devices have already been added to the project). The available
devices can be selected from Select Device with Inputs drop-down. Drag the
outputs from right pane to the left pane next to desired input of currently
selected device. Outputs assigned by accident can be deleted by using the
Delete Selected button. For information on configuring Autonomic amps
together with the MMS, see the integration guide for the Autonomic Amps.

[Image]

User Interfaces

Go to Edit User Interfaces tab. Generate Menus & Devices is selected.
Advanced options can be edited through the Advanced button. With
default options selected, click on Accelerate button. You can choose to
leave the existing menus unchanged or erase all menus. If unsure, leave
the default option selected and click OK. Click on OK button on the
Complete Notification dialog box.

[Image]

The Edit Menus by Room is displayed next.
Optional: Here you can edit the menus for all rooms for either all devices or
individual devices. Rooms can be selected in Selected Room section and device
views can be selected in Select View section. On editing a menu, click on
Apply to save the changes.
Note: In the menus generated by default, the MMS module is placed in the
Music menu. Another copy is placed in the Settings menu. You can safely
delete the copy in the Settings page, and rename the module in Music menu
by double-clicking on it.
(Below image shows sample menu with MMS module named to Mirage Media
Server in the Music menu).

[Image]

Optional: Configure the mapping of available MMS commands to hard
buttons.
Go to Edit Device Layouts. This screen allows configuration of commands
triggered on hard button presses. On Select Device Layout drop-down menu
on the left, select the applicable Mirage Media Server.

[Image]

All Hard Buttons section shows all hard buttons and their currently assigned
commands. Use Previous and Next page buttons to flip through all available
hard buttons. Menu Pages section shows commands currently unassigned to
any button. To change commands assigned to a hard button, simply drag a
command to the new button. You can modify existing commands by dragging
from one button to another, or assign new commands by dragging unassigned
commands from Menu Pages section to an empty button.
Click on Apply to save changes.

Macro Editing

Go to Macro Editing tab. Leave the default options selected and click on
Accelerate. Click on OK on the Complete Notification dialog box.
Optional: For advanced macro editing, refer to URC documentation.

[Image]

The module provides an array of Device Events and 2-way commands for custom macro programming and automation tasks. For a reference on the available device events and 2-way commands see the appendix.

Device Events

The module provides event triggers for an array of status changes on the MMS. Triggers will execute a URC macro when the programmed condition occurs.

In the Macro Editing tab click Edit Automation Macros, select Device event from Select Type of Automation Macro and click Add Macro.

I the Device Event Dialog enter the following

  • A Descriptive name for the event

  • Select the device (MMS interface)

  • Select the Event rule to base the trigger on

  • Type in and select the properties for the event that would cause the event to trigger

  • Click OK to program the macro

See the appendix for a reference to the available events

2-way commands

The module provides queries and other 2-way commands for use in macros and special functions. For a reference of the available 2-way commands see the appendix. A 2-way command can be programmed to execute in any URC macro.

Select the 2-way command button in the macro programming window and a configuration dialog appears

  • Set a descriptive name for the query in Name

  • Select the device (MMS Interface)

  • Select the Command to Query

  • Set the required parameters for the command

  • See the inline Description fields or refer to the appendix for instructions

  • If the command is a query check the Save the result checkbox and select a variable in the dropdown. Create a new Variable if desired.

  • The response value will be stored in the specified variable and can be evaluated in any macro.

Punch Through

Go to Punch Through tab. This lets you control the functioning of hard
buttons even when the Mirage Media Server module is not running. You
can set it up to control Play, Pause, Skip Next and other functions for the
MMS even if you’re in the main menu.

[Image]

For instance, the ability to control playback buttons like Play/Pause in all
menus is still possible if the MMS module isn’t running.

  1. In Select Room section in left pane, select the appropriate room.

  2. In the Select Device section in the left pane, select the screens in which
    you want to use MMS buttons.

  3. In Punch From, select the buttons you want to redirect (in this example,
    Play/Pause). Use the drop-down menu, and select the appropriate
    Mirage Media Server output for the respective room.

  4. Click Save to save your changes. Repeat the steps for desired rooms.

Download

Go to Download tab. If the accelerator project has not been saved yet,
a prompt will be shown to save it now. Click on OK on the next prompt.
A download screen will be shown with a list of all URC devices added to
the project. This will push the current project to the primary controller
and clients. Select the devices you want to download to and click on
Download to Select Devices (Direct).

[Image]

Tip: Occasionally, download fails to select clients like remotes and touchpanels.
For instance, the panel drops wifi if screen is not on or if the remote is not
charged. Touch the screen to switch it on, or place the remote on charger and
try to download again.

Technical Support

If you require further assistance with configuring the URC Module
for the Mirage Media Server, please contact Technical Support at
(914) 598-1647, option 2, or email support@autonomic-controls.com.


You can also visit the Autonomic Knowledge base
(https://autonomic.atlassian.net/wiki/spaces/ASKB/overview) for trouble-
shooting information.


For technical support with the URC Total Control 2.0/3.0 System, please contact
URC support at: https://www.urc-automation.com/support

Appendix 1: Advanced Macro Integration

2-way module commands

Special Considerations

  1. Core vs Interface

    1. All 2-way commands are designed to be run against the module Interfaces.

  2. UI Label

    1. Some 2-way commands, that affects the UI, requires the label from the Jump to the module being specified as the UI label parameter. Main, Player A and Player B are valid based on the example below.
      [Image]

    2. Here Main is specified
      [Image]

    3. After the 2-way command has been executed, future jumps to the module apply the requested settings.

  3. Retrieving data from the API

    1. The MMS’s API can be accessed using a telnet client. Since Windows
      7 Microsoft have included telnet as an optional install. Once
      installed open a command prompt and send telnet <ip> 5004.
      [Image]

    2. Once launched any available API commands can be sent, ie
      browsefavorites.
      The alpha-numeric code between the curly
      braces are the GUIDs for the favorites. These can be used in the Recall Favorite 2-way command instead of the name.
      [Image]

List of 2-way commands

  1. Play State

    1. Description: Retrieves the current Play State: Playing, Paused or Stopped

    2. Track Time

      1. Description: Retrieves the TrackTime in seconds

  2. Current Service

    1. Description: Retrieves 1 if the specified service is active otherwise 0.

    2. Parameters:

      1. Service: DropDown with the available services

      2. Other: To select a service not available in the dropdown. Select Other in the dropdown to activate the field.

  3. RepeatState

    1. Description: Retrieves 1 for on and 0 for off

  4. ShuffleState

    1. Description: Retrieves 1 for on and 0 for off

  5. Player Name

    1. Description: Retrieves the player name

  6. Tracks in Queue

    1. Description: Retrieves the total number of track in the queue

  7. Current Track in Queue

    1. Description: Retrieves the current tracks index in the queue

  8. Track Duration

    1. Description: Retrieves the length of the current track in seconds

  9. Media Type

    1. Description: Returns 1 for Track, 2 for Station, 0 for other

  10. MetaData1

    1. Description: Retrieves the current MetaData (lowercase)

  11. MetaData2

    1. Description: Retrieves the current MetaData (lowercase)

  12. MetaData3

    1. Description: Retrieves the current MetaData (lowercase)

  13. MetaData4

    1. Description: Retrieves the current MetaData (lowercase)

  14. MetaData1 Contains

    1. Description: Returns 1 if the MetaData contains the provided text

    2. Parameters

      1. Contains Text: Specified text to match

  15. MetaData2 Contains

    1. Description: Returns 1 if the MetaData contains the provided text

    2. Parameters

      1. Contains Text: Specified text to match

  16. MetaData3 Contains

    1. Description: Returns 1 if the MetaData contains the provided text

    2. Parameters

      1. Contains Text: Specified text to match

  17. MetaData4 Contains

    1. Description: Returns 1 if the MetaData contains the provided text

    2. Parameters

      1. Contains Text: Specified text to match

  18. Volume

    1. Description: Retrieves the current Volume [0-50] (Standalone without amps only)

  19. Mute

    1. Retrieves the current Mute State [range…](Standalone without amps only)

  20. Recall Favorite

    1. Description: Recalls the specified Favorite

    2. Parameters:

      1. Name or GUID: GUIDs for favorites can be retrieved by querying the API (browsefavorites or browseallfavorites). See separate section.

  21. Play Playlist

    1. Description: Loads and plays the specified PlayList (Local content)

    2. Parameters:

      1. Name or GUID: GUIDs for favorites can be retrieved by querying the API (browseplaylists). See separate section.

      2. Option: Queuing options

        1. Play Now: Add it to the queue at the current location and play the first track

        2. Play Next: Add it to the queue at the current location and play the first track next

        3. Append to queue: Add the playlist tracks to the end of the queue.

        4. Clear the queue, add the playlist’s tracks and start playing.

  22. Recall Scene

    1. Description: Recalls the specified Scene

    2. Parameters:

      1. Name or GUID: GUIDs for scenes can be retrieved by querying the API (browsescenes or browseallscenes). See separate section.

  23. Find Next Available Instance

    1. Description: Returns the next recommended player. Format: 'DefaultName@MAC', ie: Player_A@D46A916201B6

  24. Limit UI to specific services

    1. Deprecation: This functionality has been superseded by Direct Jumps to services. See section 7 in the manual.

    2. Description: Sets a flag in the system where on consecutive launches the UI will always show the specified service.

    3. Parameters

      1. UI Label: See separate section about UI label usage.

      2. Service: DropDown with the available services

      3. Other: To select a service not available in the dropdown. Select Other in the dropdown to activate the field.

      4. Allow Service Menu: Whether or not the user is allowed to

  25. Clear Queue

    1. Description: Clear the playback queue

    2. Parameters:

      1. Also stop station: When true any playing station will also stop.

  26. Set Default Service Account

    1. Deprecation: This functionality has been superseded by the 2-way command TuneBridge App user

    2. Description: The specified account is always selected when browsing to the service. The user can thereafter select another account. Use with MMS OS7 7.3 or higher Or OS6 6.7 or higher

    3. Parameters

      1. UI Label: See separate section about UI label usage.

      2. Service: DropDown with the available services

      3. Other: To select a service not available in the dropdown. Select Other in the dropdown to activate the field.

      4. Service Account: The account name requested to be the default.

  27. Set Always Browse Mode

    1. Deprecation: This functionality has been superseded by a parameter. See section 8 of the manual

    2. Description: Always open the browse screen on launch of the UI.

    3. Parameters:

      1. UI Label: See separate section about UI label usage.

      2. Always Browse: True to enable always browse mode and a False to disable.

  28. Limit Service to Account

    1. Description: The specified service is limited to the specified account for the current player. The user will not be able to select another account.

    2. Parameters

      1. UI Label: See separate section about UI label usage.

      2. Service: DropDown with the available services

      3. Other: To select a service not available in the dropdown. Select Other in the dropdown to activate the field.

      4. Service Account: The account name requested to be the default.

  29. TuneBridge App User

    1. Description: Personalize favorites and service accounts.

      1. Available for E-series and M-series streamers only.

      2. All Setup completed in the TuneBridge App.

        1. Create user

        2. Limit services for user

        3. Limit service accounts for user

    2. Parameters

      1. UI Label: See separate section about UI label usage.

      2. User Name: Enter the username as seen in the TuneBridge App. Note that the username is case sensitive.

  30. Output Trigger

    1. Description: Turning on or off Output Triggers

      1. Available for supported M-series devices only

    2. Parameters

      1. Trigger Number: Triggers are ordered numerically 1,2,3 etc. no matter the label on the actual product.

      2. State: Select the state to set the trigger to. (High or Low).

  31. API Command

    1. Description: Send custom MMS api commands. See the Control Protocol for more information: https://autonomic.atlassian.net/wiki/x/AQD6WQ

    2. Parameters

      1. Command: Custom command to send.

Device Events

Core vs Interface

  1. All Events are designed to be run against the module Interfaces.

Combination with 2-way commands

  1. Events can be combined with 2-way commands for more detailed control

    1. Example – Spotify track preview mode:

      1. Example of how to set URC to play the first 10s of each Spotify track.

      2. TrackTime event to trigger when tracktime > 10s

      3. 2-way command to query if the Current Service is Spotify and save to variable.

      4. If variable equals 1 send a skip next 1-way command

List of Events

  1. TrackTime

    1. Description: Event triggered when the track time is greater than/less than/equal to the comparison track time

      1. Note: less than will only execute when seeking from above the comparison value

    2. Parameters

      1. Comparison Operator: < (less than), > (greater than), = (equal)

      2. Comparison Tracktime: Time in seconds into the track.

  2. Selected Services

    1. Description: Event triggered when specified service is played.

    2. Parameters

      1. Service: DropDown with the available services

      2. Other: To select a service not available in the dropdown. Select Other in the dropdown to activate the field.

  3. MetaData

    1. Description: Event triggered when any of the 4 metadata fields includes the specified text.

    2. Parameters

      1. Search text: Specified text to mach

  4. Volume

    1. Description: Event triggered when the Volume is greater than/less than/equal to the comparison volume.

    2. Parameters

      1. Comparison Operator:< (less than), > (greater than), = (equal)

      2. Comparison Value:

  5. Mute

    1. Description: Event tiggered when mute state matches the specified value. (Standalone without amps only)

    2. Parameters

      1. Mute Comparison: 1 = Muted, 0 = Unmuted

  6. Input Triggers

    1. Description:Trigger Event when voltage is applied or removed from input trigger pins.

      1. Available for supported M-series devices only

    2. Parameters:

      1. Trigger Number: riggers are ordered numerically 1,2,3 etc. no matter the label on the actual product.

      2. State: Trigger on voltage applied (High) or voltage removed (Low).

  • No labels