Publications Command Strings MXA902 (English)
    Shure.com Contact Us Tech Portal

    Using a Third-Party Control System

    This device can be controlled using a third-party control system with the appropriate command string.

    Common applications:

    • Mute
    • LED color and behavior
    • Loading presets
    • Adjusting levels
    • Integration with camera systems

    The device is connected via Ethernet to a control system, such as AMX, Crestron or Extron.

    • Connection: Ethernet (TCP/IP; select “Client” in the AMX/Crestron program)
    • Port: 2202

    If using static IP addresses, set the Shure Control and the Audio Network settings to Manual in Designer. Use the Control IP address for TCP/IP communication with Shure devices.

    See below for all supported command strings. This list is updated with each firmware release.

    Using PuTTY and Other Telnet Clients

    For all Telnet clients (including PuTTY), set Telnet negotiation to disabled or passive mode. Active Telnet negotiation is not supported by MXA devices.

    If using PuTTY to enter commands for MXA devices, the first command you send may return an error. To fix, enter the command again and it should work normally.

    Channel Number Assignments

    MXA902 ceiling arrays use this numbering to distinguish the channels for REP values:

    • Automixer output: 09
    • Speaker output (summed Dante inputs/AEC reference): 10
    • Dante inputs: 11-12

    Device Information

    Use these commands to get information about the device, reboot, and restore default settings.

    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 >

    Serial Number

    Parameter Name: SERIAL_NUM
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s): serial_num is a 32 alphanumeric character string. Response is padded to ensure that 32 characters are always returned
    Example(s):


    < GET SERIAL_NUM >

    < REP SERIAL_NUM serial_num >

    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 >

    IP Address for Primary Audio Network

    Parameter Name: IP_ADDR_NET_AUDIO_PRIMARY
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s):
    • The value of IP address consist of 4 octets each separated by a period.
    • The length of IP address is 15 characters.
    • The value will be padded to ensure that 15 characters are always returned.
    Example(s):


    < GET IP_ADDR_NET_AUDIO_PRIMARY >

    < REP IP_ADDR_NET_AUDIO_PRIMARY ip_addr >

    < REP ERR >

    Subnet Mask for the Primary Audio Network

    Parameter Name: IP_SUBNET_NET_AUDIO_PRIMARY
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s):
    • subnet is subnet mask:
      • 32 bit number represented in the Binary Coded Decimal notation in the form of A.B.C.D where each variable A or B or C or D are 8 bit octets each separated by a period.
      • The length of subnet is 15 characters.
      • The value will be padded to ensure that 15 characters are always returned.
    Example(s):


    < GET IP_SUBNET_NET_AUDIO_PRIMARY >

    < REP IP_SUBNET_NET_AUDIO_PRIMARY subnet >

    < REP ERR >

    Network Gateway for Primary Audio Network Interface

    Parameter Name: IP_GATEWAY_NET_AUDIO_PRIMARY
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s):
    • gateway is network gateway:
      • 32 bit number represented in the Binary Coded Decimal notation in the form of A.B.C.D where each variable A or B or C or D are 8 bit octets each separated by a period.
      • The length of subnet is 15 characters.
      • The value will be padded to ensure that 15 characters are always returned.
    Example(s):


    < GET IP_GATEWAY_NET_AUDIO_PRIMARY >

    < REP IP_GATEWAY_NET_AUDIO_PRIMARY gateway >

    < REP ERR >

    Control MAC Address

    Parameter Name: CONTROL_MAC_ADDR
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s): addr is a 17 character literal string formatted as 6 octets, each separated by a colon.

    Example: 00:0E:DD:FF:F1:63
    Example(s):


    < GET CONTROL_MAC_ADDR >

    < REP CONTROL_MAC_ADDR addr >

    < REP ERR >

    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 >

    Channel Name

    Parameter Name: CHAN_NAME
    Command Types Supported: GET, 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.
    Value(s): string is 31 character channel name. Value is padded with spaces as needed to ensure that 31 characters are always reported.
    Example(s):


    < GET index CHAN_NAME >

    < REP index CHAN_NAME string >
    < REP ERR >

    Network Audio (Dante) Channel Name

    Parameter Name: NA_CHAN_NAME
    Command Types Supported: GET, 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.
    Value(s): string is 31 character channel name. Value is padded with spaces as needed to ensure that 31 characters are always reported.
    Example(s):


    < GET index NA_CHAN_NAME >

    < REP index NA_CHAN_NAME string >
    < REP ERR >

    Network Audio (Dante) 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 >

    Identify Device (Flash LED)

    Parameter Name: FLASH
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): flash_state takes on values
    • ON
    • OFF
    Example(s):


    < GET FLASH >
    < SET FLASH flash_state >
    < REP FLASH flash_state >
    < REP ERR >

    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 >

    View Preset Name

    Parameter Name: PRESET_NAME
    Command Types Supported: GET, REP
    Indexing: 1-10: specific preset identifier
    Value(s):

    name is a literal string 25 alphanumeric characters long, special characters allowed except blank spaces, {} and < >.

    Note that if a preset is empty, name will say {empty}
    Example(s):


    < GET PRESET_NAME nn >
    < REP PRESET_NAME nn name >
    < REP ERR >

    Device Encryption Status

    Parameter Name: ENCRYPTION
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s): sts is the encryption status, which can have the following values:
    • ON
    • OFF
    Example(s):


    < GET ENCRYPTION >
    < REP ENCRYPTION sts >
    < REP ERR >

    Restore Default Settings

    Parameter Name: DEFAULT_SETTINGS
    Command Types Supported: SET, REP
    Indexing: n/a
    Value(s): ## = 00 if restore is successful
    Example(s):


    < SET DEFAULT_SETTINGS >
    < REP DEFAULT_SETTINGS ## >
    < REP ERR >

    Reboot

    Note: This command does not send acknowledgement.

    Parameter Name: REBOOT
    Command Types Supported: SET
    Indexing: n/a
    Value(s): n/a
    Example(s):


    < SET REBOOT >

    Get Error Events

    Parameter Name: LAST_ERROR_EVENT
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s): Sends the last error logged on the device, as represented by {str}. {str} is up to 128 characters long.
    Example(s):


    < GET LAST_ERROR_EVENT >
    < REP LAST_ERROR_EVENT {str} >
    < REP ERR >

    Channel and Loudspeaker Commands

    Use these commands to adjust gain, mute channels, and turn the loudspeaker on or off.

    Audio Clip Indicator

    Parameter Name: AUDIO_OUT_CLIP_INDICATOR
    Command Types Supported: GET, 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.
    Value(s): sts is current status for the channel:
    1. OFF
    2. ON
    Example(s):


    < GET index AUDIO_OUT_CLIP_INDICATOR >
    < REP index AUDIO_OUT_CLIP_INDICATOR sts >
    < REP ERR >

    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 >

    Audio Level (RMS)

    Parameter Name: AUDIO_IN_RMS_LVL
    Command Types Supported: GET, REP
    Indexing:
    • GET index: Channel Number Assignment for product-specific channel assignments. 0 = all channels.
    • REP index: Single digit representation of the index sent in the GET, all the appropriate channels if the index = 0.
    Value(s): ### is audio level in the range of 00-60.
    Example(s):


    < GET x AUDIO_IN_RMS_LVL >
    < REP x AUDIO_IN_RMS_LVL ### >
    < REP ERR >

    Audio Level (Peak)

    Parameter Name: AUDIO_IN_PEAK_LVL
    Command Types Supported: GET, REP
    Indexing:
    • GET index: Channel Number Assignment for product-specific channel assignments. 0 = all channels.
    • REP index: Single digit representation of the index sent in the GET, all the appropriate channels if the index = 0.
    Value(s): ### is audio level in the range of 000-060.
    Example(s):


    < GET index AUDIO_IN_PEAK_LVL >
    < REP index AUDIO_IN_PEAK_LVL ### >
    < REP ERR >

    Device Mute

    Mute and unmute device audio, and get mute status information for the device.

    MXA902 only: Device mute mutes both the microphone and loudspeaker output.

    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:

    GET index: See Channel Number Assignments 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.

    Changing the channel mute setting on microphone section and loudspeaker section at the same time is not supported.
    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 >

    Loudspeaker On/Off

    Turn the MXA902's loudspeaker on or off.

    Parameter Name: SPEAKER
    Command Types Supported: GET, SET, REP
    Indexing: N/A
    Value(s): sts is the state of the loudspeaker:
    • ON
    • OFF
    Example(s):


    < GET SPEAKER >
    < SET SPEAKER sts >
    < REP SPEAKER sts >
    < REP ERR >

    Meter Rate Commands

    Adjust different meter rates using these commands.

    Metering Rate (RMS)

    Parameter Name: METER_RATE
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): rate is a value from 100 to 99999 representing meter rate in milliseconds.
    • 0 = off
    • Values 1 to 99 are not valid and result in <REP ERR> response.
    aaa bbb ccc ddd - Audio Levels take on values 000-060, which represent actual audio levels of -60 to 0 dBFS. Represent channels in order defined in Channel Number Assignment.
    Example(s):


    < GET METER_RATE >
    < SET METER_RATE rate >
    < REP METER_RATE rate >
    < REP ERR >
    < SAMPLE aaa bbb ccc ddd >

    Metering Rate Pre-Compressor (RMS)

    Parameter Name: METER_RATE_PRECOMP
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): ##### is a value from 100 to 99999 representing meter rate in milliseconds.
    • 0 = off
    • Values 1 to 99 are not valid and result in <REP ERR> response.
    aaa bbb: Audio levels take on values 000-060, which represent actual audio levels of −60 to 0 dBFS. The MXA902 has a compressor on the automix output channel and a compressor on the loudspeaker output channel.
    • aaa: Automix output channel compressor
    • bbb: Loudspeaker output channel compressor
    Example(s):


    < GET METER_RATE_PRECOMP >
    < SET METER_RATE_PRECOMP ##### >
    < REP METER_RATE_PRECOMP ##### >
    < REP ERR >
    < SAMPLE_PRECOMP aaa bbb >

    AEC Reference In Metering Rate (RMS)

    Parameter Name: METER_RATE_AECREF
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): rate is a value from 100 to 99999 representing meter rate in milliseconds.
    • 0 = off
    • Values 1 to 99 are not valid and result in <REP ERR> response.
    aaa bbb ccc ddd - Audio levels take on values 000-060, which represent actual audio levels of −60 to 0 dBFS. Represent mic input channels in order defined in Channel Number Assignment.
    Example(s):


    < GET METER_RATE_AECREF >
    < SET METER_RATE_AECREF rate >
    < REP METER_RATE_AECREF rate >
    < REP ERR >
    < SAMPLE aaa >

    LED Status and Behavior

    Control status LED color and behavior with these commands.

    Mute LED State

    Parameter Name: DEV_MUTE_STATUS_LED_STATE
    Command Types Supported: GET, REP
    Indexing: n/a
    Value(s): sts is current mute LED state that takes on these values:
    • ON = MUTED
    • OFF = UNMUTED
    Example(s):


    < GET DEV_MUTE_STATUS_LED_STATE >
    < REP DEV_MUTE_STATUS_LED_STATE sts >
    < REP ERR >

    LED Brightness

    Parameter Name: LED_BRIGHTNESS
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): level is the desired brightness level and takes on values:
    • 0: Disabled
    • 1: 20%
    • 2: 40%
    • 3: 60%
    • 4: 80%
    • 5: 100%
    Example(s):


    < GET LED_BRIGHTNESS >
    < SET LED_BRIGHTNESS level >
    < REP LED_BRIGHTNESS level >
    < REP ERR >

    LED Color Unmuted

    Parameter Name: LED_COLOR_UNMUTED
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): color: RED, ORANGE, GOLD, YELLOW, YELLOWGREEN, GREEN, TURQUOISE, POWDERBLUE, CYAN, SKYBLUE, BLUE, PURPLE, LIGHTPURPLE, VIOLET, ORCHID, PINK, WHITE
    Example(s):


    < GET LED_COLOR_UNMUTED >
    < SET LED_COLOR_UNMUTED color >
    < REP LED_COLOR_UNMUTED color >
    < REP ERR >

    LED Color Muted

    Parameter Name: LED_COLOR_MUTED
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): color: RED, ORANGE, GOLD, YELLOW, YELLOWGREEN, GREEN, TURQUOISE, POWDERBLUE, CYAN, SKYBLUE, BLUE, PURPLE, LIGHTPURPLE, VIOLET, ORCHID, PINK, WHITE
    Example(s):


    < GET LED_COLOR_MUTED >
    < SET LED_COLOR_MUTED color >
    < REP LED_COLOR_MUTED color >
    < REP ERR >

    LED State Muted

    Parameter Name: LED_STATE_MUTED
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): state: ON, FLASHING, OFF
    Example(s):


    < GET LED_STATE_MUTED >
    < SET LED_STATE_MUTED state >
    < REP LED_STATE_MUTED state >
    < REP ERR >

    LED State Unmuted

    Parameter Name: LED_STATE_UNMUTED
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): state: ON, FLASHING, OFF
    Example(s):


    < GET LED_STATE_UNMUTED >
    < SET LED_STATE_UNMUTED state >
    < REP LED_STATE_UNMUTED state >
    < REP ERR >

    Device LED In State

    Parameter Name: DEV_LED_IN_STATE
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): sts indicates device's LED-In state:
    1. OFF = Mute
    2. ON = Unmute
    Example(s):


    < GET DEV_LED_IN_STATE >
    < SET DEV_LED_IN_STATE sts >
    < REP DEV_LED_IN_STATE sts >
    < REP ERR >

    DSP Commands

    Use these commands to adjust DSP settings.

    PEQ Filter Enable

    Parameter Name: PEQ
    Command Types Supported: GET, SET, 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.
    • Note for MXA902: Changing settings on both channels at the same time is not supported.
      • 09: PEQ on automix output
      • 10: PEQ on loudspeaker output
    • filter is the filter number in the selected PEQ block index. 0: all filters.
    Value(s): sts is the desired PEQ filter status:
    • ON
    • OFF
    • TOGGLE
    Example(s):


    < GET index PEQ filter >
    < SET index PEQ filter sts >
    < REP index PEQ filter sts >
    < REP ERR >

    EQ Contour

    Parameter Name: EQ_CONTOUR
    Command Types Supported: GET, SET, REP
    Indexing: n/a
    Value(s): sts takes on values:
    • OFF
    • ON
    Example(s):


    < GET EQ_CONTOUR >
    < SET EQ_CONTOUR sts >
    < REP EQ_CONTOUR sts >
    < REP ERR >

    Delay

    Parameter Name: DELAY
    Command Types Supported: GET, SET, REP
    Indexing: index is selected output channels that have delay feature. Channels are defined in Channel Number Assignment.

    GET index : Selected output channels that support delay. 0 = all relevant channels.

    MXA902: channel 10. This is the loudspeaker's delay block. There is no control for the microphone's delay block.

    REP index: Double-digit representation of the index sent in the GET, all the appropriate channels if the index = 0.
    Value(s): #### is delay data in 1 ms increment.

    Delay range:

    • 0 means delay block is disabled.
    • MXA902: 1 to 160 ms
    Example(s):


    < GET index DELAY >
    < SET index DELAY #### >
    < REP index DELAY #### >
    < REP ERR >

    Compressor

    Parameter Name: COMPRESSOR
    Command Types Supported: GET, SET, REP
    Indexing:

    GET index:automixer output channel defined in Channel Number Assignment. 0 = all channels.

    REP index: 2-digit representation of the index sent in the GET, all the appropriate channels if the index = 0.

    Note: Changing compressor setting on both microphone section and loudspeaker section at the same time is not supported.
    Value(s): sts is the desired compressor state:
    • ON
    • OFF
    • TOGGLE
    Example(s):


    < GET index COMPRESSOR >
    < SET index COMPRESSOR sts >
    < REP index COMPRESSOR sts >
    < REP ERR >

    Signal Generator Type

    Allows you to set and view the signal generator type.

    Parameter Name: SIG_GEN_TYPE
    Command Types Supported: GET, SET, REP
    Indexing:
    • GET index: Channels are defined in Channel Number Assignment. 0 = all relevant channels.
    • REP index: 2-digit representation of the index sent in the GET, all the appropriate channels if the index= 0.
    Value(s): type is type of signal generator:
    • PINK
    • WHITE
    • TONE
    Example(s):


    < GET index SIG_GEN_TYPE >
    < SET index SIG_GEN_TYPE type >
    < REP index SIG_GEN_TYPE type >
    < REP ERR >

    Signal Generator Tone Frequency

    Allows you to set and view the signal generator frequency then the signal generator type is tone.

    Parameter Name: SIG_GEN_FREQ
    Command Types Supported: GET, SET, REP
    Indexing:
    • GET index: Channels are defined in Channel Number Assignment. 0 = all relevant channels.
    • REP index: 2-digit representation of the index sent in the GET. All the appropriate channels if the index= 0.
    Value(s): sts is a single frequency in the range of 125 to 20,000 Hz in 1 Hz increments.
    Example(s):


    < GET index SIG_GEN_FREQ >
    < SET index SIG_GEN_FREQ sts >
    < REP index SIG_GEN_FREQ sts >
    < REP ERR >

    Signal Generator Gain

    Parameter Name: SIG_GEN_GAIN
    Command Types Supported: GET, SET, REP
    Indexing:
    • GET index: Channels are defined in Channel Number Assignment. 0 = all relevant channels.
    • REP index: 2-digit representation of the index sent in the GET. All the appropriate channels if the index= 0.
    Value(s): gain is in the range of 0-1220, which represents −110 to 12 dB in 0.1 dB increments. The dB value is first converted to integer and then scaled by 1100.
    Example(s):


    < GET index SIG_GEN_GAIN >
    < SET index SIG_GEN_GAIN gain >
    < REP index SIG_GEN_GAIN gain >
    < REP ERR >

    Signal Generator Start/Stop

    Parameter Name: SIG_GEN
    Command Types Supported: GET, SET, REP
    Indexing:
    • GET index: Channels are defined in Channel Number Assignment. 0 = all relevant channels.
    • REP index: 2-digit representation of the index sent in the GET. All the appropriate channels if the index= 0.
    Value(s): sts can be:
    • START
    • STOP
    • TOGGLE
    Example(s):


    < GET index SIG_GEN >
    < SET index SIG_GEN sts >
    < REP index SIG_GEN sts >
    < REP ERR >