This device can be controlled using a third-party control system with the appropriate command string.
Common applications:
The device is connected via Ethernet to a control system, such as AMX, Crestron or Extron.
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.
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:
Parameter Name: | ALL |
Command Types Supported: | GET, REP |
Indexing: | See Channel Number Assignments |
Value(s): |
x is channel.
Sends all parameters that can be reported. The reply is only sent once on receipt of the < GET x ALL > command. |
Example(s): |
|
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): |
|
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): |
|
Parameter Name: | FW_VER |
Command Types Supported: | GET, REP |
Indexing: | n/a |
Value(s): |
Where ver is an 18 character literal string:
|
Example(s): |
|
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): |
|
Parameter Name: | DEVICE_ID |
Command Types Supported: | GET, REP |
Indexing: | n/a |
Value(s): |
|
Example(s): |
|
Parameter Name: | FLASH |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): |
flash_state takes on values
|
Example(s): |
|
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): |
|
Parameter Name: | DEFAULT_SETTINGS |
Command Types Supported: | SET, REP |
Indexing: | n/a |
Value(s): | ## = 00 if restore is successful |
Example(s): |
|
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): |
|
Note: This command does not send acknowledgement.
Parameter Name: | REBOOT |
Command Types Supported: | SET |
Indexing: | n/a |
Value(s): | n/a |
Example(s): |
|
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): |
|
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:
|
Example(s): |
|
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:
|
Example(s): |
|
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): |
|
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): |
|
Parameter Name: | LED_STATE_MUTED |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): | state: ON, FLASHING, OFF |
Example(s): |
|
Parameter Name: | LED_STATE_UNMUTED |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): | state: ON, FLASHING, OFF |
Example(s): |
|
Parameter Name: | DEV_LED_IN_STATE |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): |
sts indicates device's LED-In state:
|
Example(s): |
|
Parameter Name: | MUTE_BUTTON_STATUS |
Command Types Supported: | GET, REP |
Indexing: | n/a |
Value(s): | sts is current mute button press status and takes on values: ON, OFF, or UNKNOWN |
Example(s): |
|
Parameter Name: | EXT_SWITCH_OUT_STATE |
Command Types Supported: | GET, REP |
Indexing: | n/a |
Value(s): |
sts indicates device's switch out state:
|
Example(s): |
|
Parameter Name: | AUDIO_MUTE |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): |
cmd is desired mute status and takes on values:
sts is the current mute status for the designated channel and takes on values:
When using the SET command, the device sends 2 replies. The first reply is the current state and the second reply is the desired state. For example: < SET AUDIO_MUTE ON > |
Example(s): |
|
Parameter Name: | MUTE_CONTROL_FUNC |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): |
sts indicates device's mute control setting:
|
Example(s): |
|
Parameter Name: | MUTE_CONTROL_MODE |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): |
mode is:
|
Example(s): |
|
Parameter Name: | DEFAULT_TOGGLE_STATE |
Command Types Supported: | GET, SET, REP |
Indexing: | n/a |
Value(s): |
state is:
|
Example(s): |
|
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.