Using Command Strings with IntelliMix® Room

To control IntelliMix Room with third-party control systems, turn on command strings in Designer. You must choose an open port on the computer running IntelliMix Room to send and receive command strings.

Default port: 2202

Port range: 1025-65534

  1. In Designer, open the installation of IntelliMix Room you want to control and go to Settings > Command strings.
  2. Turn on command strings.
  3. Enter an available port to send and receive the command strings. Make sure that the port isn't being used by any other programs installed on the computer.

    To test if the port is available:

    • Send a <GET NA_DEVICE_NAME> command to IntelliMix Room. Make sure you are targeting IntelliMix Room's control IP address.
    • If you don't receive a response, the port is being used by another program.
    • Try a different port number and send the <GET NA_DEVICE_NAME> command until you receive a <REP NA_DEVICE_NAME {string}> response.
    • For best results, install all software on the computer before choosing a port for command strings. Adding new software after setting up command strings can change how the computer's ports are used, which can affect command strings.

A complete list of command strings is available at pubs.shure.com/command-strings/IntelliMixRoom.

Command String Conventions

When you make changes to a parameter, the device sends a REPORT string with information about what you changed. You don't need to constantly query parameters.

All messages are ASCII, including level and gain indicators.

This device uses 4 types of strings:

  • GET
    • Finds the status of a parameter. The device responds with a REPORT string.
  • SET
    • Changes the status of a parameter. The device responds with a REPORT string that shows the parameter's new value.
  • REP
    • The device sends REPORT strings to show the status of parameters anytime a parameter changes.
  • SAMPLE
    • Used for metering audio levels.

Channel Number Assignments

IntelliMix Room uses the following numbering to distinguish the channels for REP values. The channels use 2 digits even if the channel number is less than 10.

  • All Channels: 00
  • Dante Mic Inputs: 01-16
    • There are 8 and 16 channel versions of IntelliMix Room. If you have a version that is not the full 16 channels, command strings that refer to the unlicensed channels will fail.
  • Dante Line Inputs: 17-24
  • Virtual Audio Input: 25
  • PC Input: 26
  • Dante Outputs: 27-34
  • Virtual Audio Output: 35
  • PC Output: 36
  • Automix Output: 37

Get All

Parameter Name: ALL
Command Types Supported: GET, REP
Indexing: n/a
Value(s): Responds with REP for all device-specific properties and ALL channel-related properties.
Example(s):


< GET ALL >

Model

Parameter Name: MODEL
Command Types Supported: GET, REP
Indexing: n/a
Value(s): model is a 32 character quoted string. The value is padded with spaces to ensure that 32 characters are reported.
Example(s):


< GET MODEL >

< REP MODEL model >

Firmware Version

Parameter Name: FW_VER
Command Types Supported: GET, REP
Indexing: n/a
Value(s):

Where ver is an 18 character literal string:

  • The value is 3 versions separated by a period.
  • Each version shall be able to take on a value from 0 to 65535.
  • ver has an "*" if the firmware is invalid.
  • Example: 65535.65535.65535
Example(s):


< GET FW_VER >

< REP FW_VER ver >

Device ID

Parameter Name: DEVICE_ID
Command Types Supported: GET, REP
Indexing: n/a
Value(s):
  • Response is a text string.
  • Most devices allow device ID to be up to 31 characters.
  • Value is padded with spaces as needed to ensure that 31 characters are always reported
Example(s):


< GET DEVICE_ID >

< REP DEVICE_ID string >

NA Device Name

Parameter Name: NA_DEVICE_NAME
Command Types Supported: GET, REP
Indexing: n/a
Value(s):
  • Response is a text string.
  • Most devices allow device ID to be up to 31 characters.
  • Value is padded with spaces to ensure that 31 characters are always reported.
Example(s):


< GET NA_DEVICE_NAME >

< REP NA_DEVICE_NAME string >

Audio Gain (Digital)

Parameter Name: AUDIO_GAIN_HI_RES
Command Types Supported: GET, SET (INC, DEC), REP
Indexing:
  • GET index: See Channel Number Assignment for product-specific channel assignments. 0 = all channels.
  • REP index: 2 digit representation of the index sent in the GET, all the appropriate channels if the index = 0.
Setting gain on all channels at once is not supported.
Value(s):

gain is in units of one-tenth of a dB. The value is multiplied by 10 and then scaled by 1100. The resulting value has a range of 0 to 1400 representing gain from -110.0 dB to 30.0 dB.

step is in units of one-tenth of a dB. The resulting gain when the step is applied must be in the range allowed in the SET.

Example(s):


< GET index AUDIO_GAIN_HI_RES >
< SET index AUDIO_GAIN_HI_RES gain >
< SET index AUDIO_GAIN_HI_RES inc step >
< SET index AUDIO_GAIN_HI_RES dec step >
< REP index AUDIO_GAIN_HI_RES gain >
< REP ERR >

Device Mute

Parameter Name: DEVICE_AUDIO_MUTE
Command Types Supported: GET, SET, REP
Indexing: n/a
Value(s):

cmd is desired mute status and takes on values:

  • ON
  • OFF
  • TOGGLE

sts is the current mute status for the designated channel and takes on values:

  • ON
  • OFF
Example(s):


< GET DEVICE_AUDIO_MUTE >
< SET DEVICE_AUDIO_MUTE cmd >
< REP DEVICE_AUDIO_MUTE sts >

Channel Mute

Parameter Name: AUDIO_MUTE
Command Types Supported: GET, SET, REP
Indexing: Where nn is the channel and takes on values defined in channel number assignments.
Value(s):

cmd is desired mute status and takes on values:

  • On
  • Off
  • Toggle

sts is the current mute status for the designated channel and takes on values:

  • ON
  • OFF
Example(s):


< GET nn AUDIO_MUTE >
< SET nn AUDIO_MUTE cmd >
< REP nn AUDIO_MUTE sts >

Presets

Parameter Name:

PRESET

Command Types Supported: GET, SET, REP
Indexing: ## is the preset number and takes on values 1-10.
Value(s): n/a
Example(s):


< GET PRESET >
< SET PRESET ## >
< REP PRESET ## >
< REP ERR >

Matrix Mixer Routing

Parameter Name: MATRIX_MXR_ROUTE
Command Types Supported: GET, SET, REP
Indexing: See Channel Number Assignment for product-specific channel assignments.

input: 00 (all input channels)

output: 00 (all output channels)

Value(s): sts takes on these values:
  1. ON
  2. OFF
Example(s):


< GET input MATRIX_MXR_ROUTE output >
< SET input MATRIX_MXR_ROUTE output sts >
< REP input MATRIX_MXR_ROUTE output sts >
< REP ERR >

Matrix Mixer Gain

Parameter Name:

MATRIX_MXR_GAIN

Command Types Supported: GET, SET (INC, DEC), REP
Indexing: See Channel Number Assignment for product-specific channel assignments.

input: 00 (all input channels)

output: 00 (all output channels)

Value(s): gain is in units of one-tenth of a dB. The value is multiplied by 10 and then scaled by 1100. The resulting value has a range of 0 to 1400 representing gain from -110.0 dB to 30.0 dB. gain is always 4 digits long.

step is obtained by multiplying the actual desired step by 10, e.g. 2.5 dB would be represented by 25.

Example(s):


< GET input MATRIX_MXR_GAIN output >
< SET input MATRIX_MXR_GAIN output gain >
< SET input MATRIX_MXR_GAIN output inc step >
< SET input MATRIX_MXR_GAIN output dec step >
< REP input MATRIX_MXR_GAIN output gain >
< REP ERR >

On/Off-Hook Support

Parameter Name: ONHOOK_ENABLE
Command Types Supported: GET, SET, REP
Indexing: N/A
Value(s): state can be:
  • ON
  • OFF
Example(s):


< GET ONHOOK_ENABLE >
< SET ONHOOK_ENABLE state >
< REP ONHOOK_ENABLE state >

On/Off-Hook State

Parameter Name: ONHOOK_STATE
Command Types Supported: GET, REP
Indexing: n/a
Value(s): When on-hook support is enabled, device reports state as one of:
  • ONHOOK (not in a call)
  • OFFHOOK (in a call)
When on-hook support is disabled, device reports state as OFFHOOK.
Example(s):


< GET ONHOOK_STATE >
< REP ONHOOK_STATE state >

Denoiser Enable

Parameter Name: DENOISER_ENABLE
Command Types Supported: GET, SET, REP
Indexing: n/a
Value(s): xx is 00 or 37

state can be:

  • ON
  • OFF
Example(s):


< GET xx DENOISER_ENABLE >
< SET xx DENOISER_ENABLE state >
< REP xx DENOISER_ENABLE state >

Denoiser Level

Parameter Name: DENOISER_LEVEL
Command Types Supported: GET, SET, REP
Indexing: n/a
Value(s): xx is 00 or 37

level can be:

  • LOW
  • MEDIUM
  • HIGH
Example(s):


< GET xx DENOISER_LEVEL >
< SET xx DENOISER_LEVEL level >
< REP xx DENOISER_LEVEL level >

Automixer Post-Gate Mute

Parameter Name:

AUTOMXR_MUTE

Command Types Supported: GET, SET, REP
Indexing: xx is 01-16 for input channels and 37 is for the automix output.
Value(s):

cmd is desired mute status and takes on values:

  • On
  • Off
  • Toggle

sts is the current mute status for the designated channel and takes on values:

  • ON
  • OFF
Example(s):


< GET xx AUTOMXR_MUTE >
< SET xx AUTOMXR_MUTE cmd >
< REP xx AUTOMXR_MUTE sts >
< REP ERR >

Audio Gain Postgate

Parameter Name: AUDIO_GAIN_POSTGATE
Command Types Supported: GET, SET, REP
Indexing: xx is 01-16 for input channels and 37 is for the automix output.
Value(s):

gain is in units of one-tenth of a dB and then scaled by 1100 and takes on values 0 to 1400 representing gain from -109.9 dB to 30.0 dB

step is in units of one-tenth of a dB. The resulting gain when the step is applied must be in the range allowed in the SET.

Example(s):


< GET xx AUDIO_GAIN_POSTGATE >
< SET xx AUDIO_GAIN_POSTGATE gain >
< SET xx AUDIO_GAIN_POSTGATE inc step >
< SET xx AUDIO_GAIN_POSTGATE dec step >
< REP xx AUDIO_GAIN_POSTGATE gain >
< REP ERR >

Automixer Gate Status

Parameter Name: AUTOMXR_GATE
Command Types Supported: GET, REP
Indexing: xx is the channel number (see channel number assignments).
Value(s):

sts is the current mute status for the designated channel and takes on values:

  • ON
  • OFF
Example(s):


< GET xx AUTOMXR_GATE >
< REP xx AUTOMXR_GATE sts >
< REP ERR >

Channels Configured

Parameter Name: CHAN_CONFIG
Command Types Supported: GET, REP
Indexing: n/a
Value(s): Where status is TRUE / FALSE.
Example(s):


< GET CHAN_CONFIG >
< REP CHAN_CONFIG status >

Channel Count

Parameter Name: CHAN_COUNT
Command Types Supported: GET, REP
Indexing: n/a
Value(s): Where ## is the number of channels licensed by this IntelliMix Room installation. Possible values are 08 and 16.
Example(s):


< GET CHAN_COUNT >
< REP CHAN_COUNT ## >

Licensing Expiration

Parameter Name: LIC_EXP_DATE
Command Types Supported: GET, REP
Indexing: n/a
Value(s): Where date is a 10 character literal string. The values is comprised of yyyy-mm-dd, this is the license entitlement expiration (ignoring the grace period).
Example(s):


< GET LIC_EXP_DATE >
< REP LIC_EXP_DATE date >

Licensing Type

Parameter Name: LIC_TYPE
Command Types Supported: GET, REP
Indexing: n/a
Value(s): Where type is a 10 character literal string with the following possible values:
  • DEMO
  • PAID
  • TRIAL
  • UNKNOWN
Example(s):


< GET LIC_TYPE >
< REP LIC_TYPE type >

Licensing Validity

Parameter Name: LIC_VALID
Command Types Supported: GET, REP
Indexing: n/a
Value(s): Where status is TRUE / FALSE.
Example(s):


< GET LIC_VALID >
< REP LIC_VALID status >

Contact Customer Support

Didn't find what you need? Contact our customer support to get help.