Shure command strings are a set of commands and status reports used by control system programmers to interface to Shure devices. The Shure device is connected via Ethernet to a control system, such as
The Shure device is considered to be the server and the control system is considered to be the client.
Connection: Ethernet (TCP/IP; select “Client” in the AMX/Crestron program)
Port: 2202
There are 4 types of strings
| GET | Finds the status of a parameter. After the AMX/Crestron sends a GET command, the system responds with a REPORT string |
| SET | Changes the status of a parameter. After the AMX/Crestron sends a SET command, the system responds with a REPORT string to indicate the new value of the parameter. |
| REP |
|
| SAMPLE | Used for metering audio levels. (Not applicable with some Shure devices.) |
Note:
| Description | Discovery of device properties. |
| Commands |
< GET x ALL > |
| Variables | When x is zero, the device responds with REP for all device-specific properties and ALL channel, module, or bay-related properties including all metered properties. When x is a channel, module, or bay number, the device responds with REP for all device-specific properties and ALL channel, module, or bay x-related properties, including all metered properties. |
| Notes | None. |
| Description | Controls the Device ID. |
| Commands |
< GET DEVICE_ID > |
| Variables | Where the repeating y represents the spaces returned by the device to pad the Device ID to 31 characters. |
| Notes |
The device always responds with 31-character ID. SET accepts 1-8 Characters from the set: A-Z,a-z,0-9,!"#$%&'()*+,-./:;<=>?@[\]^_`~ and space. |
| Description | Discovery of the firmware version. |
| Commands | Self test passed: < GET FW_VER > < GET FW_VER > |
| Variables |
Where the repeating y represents the spaces returned by the device to pad the response to 24 characters. |
| Notes | Package version number reported as Maj.Min.Pack.Build. |
| Description | Controls the flash to identify a device. |
| Commands |
< SET FLASH ON > |
| Variables | None. |
| Notes | Device initiates an Identify then stops flashing. |
| Description | Discovery of the model name of the device. |
| Commands |
< GET MODEL > |
| Variables | Where the repeating y represents the spaces returned by the device to pad the model name to 32 characters. |
| Notes | The device always responds with a 32-character model name. |
| Description | Controls the storage mode setting. |
| Commands |
< GET STORAGE_MODE > |
| Variables | None. |
| Notes | TOGGLE switches between ON and OFF. |
| Description | Discovers the type of the battery module. |
| Commands |
< GET x BATT_MODULE_TYPE > |
| Variables |
Where x is the module number. Using 0 returns information for all modules |
| Notes | Numeric string, 3 characters Identifies the model of the module: 000 : No module installed 001 : AXT902 002 : AXT901 003 : SBC-AX (For SB900x) 004 : SBM920 005 : SBM910 006 : SBM910M 255 : Invalid / Unsupported module |
| Description | Discovers the number of bars for a battery. |
| Commands |
< GET x BATT_BARS > < REP x BATT_BARS 004 > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, three characters 000 - 005 : Number of bars reported 254 : An error has occurred, the value is not applicable at this time 255 : Unknown |
| Description | Discovers the manufacturer's battery maximum capacity in mAh. |
| Commands |
< GET x BATT_CAPACITY_MAX > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, five characters 00000 - 65533 : The manufacturer's battery maximum capacity in mAh 65534 : An error has occurred, the value is not applicable at this time 65535 : No battery or not applicable |
| Description | Discovers the charge in percent for a battery. |
| Commands |
< GET x BATT_CHARGE > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, three characters 000 - 100 : Percentage of charge 254 : An error has occurred, the value is not applicable at this time 255 : Unknown |
| Description | Discovers the current battery capacity in mAh. |
| Commands |
< GET x BATT_CURRENT_CAPACITY > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, five characters 00000 - 65533 : The current battery capacity in mAh 65534 : An error has occurred, the value is not applicable at this time 65535 : No battery or not applicable |
| Description | Discovers the current maximum capacity in mAh. |
| Commands |
< GET x BATT_CURRENT_CAPACITY_MAX > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, five characters 00000 - 65533 : The current battery maximum capacity in mAh 65534 : An error has occurred, the value is not applicable at this time 65535 : No battery or not applicable |
| Description | Discovers the number charging cycles for a battery. |
| Commands | Battery placed into charger bay x: < REP x BATT_CYCLE 00006 > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, five characters 00000 - 65533 : Number of charging cycles 65534 : An error has occurred, the value is not applicable at this time 65535 : Unknown or not applicable |
| Description | Discovers if a battery is detected. |
| Commands |
< GET x BATT_DETECTED > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes | Fixed String
|
| Description | Discovers the error status of a battery. |
| Commands |
< GET x BATT_ERROR > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes | Numeric, three characters 000 : No Active Error 001 : Unknown Module 002 : Unrecognized Battery 003 : Deep Discharge Recovery Failed 004 : Charge Failed 005 : Check Battery 006 : Check Charger 007 : Communication Failure 255 : No Battery Present |
| Description | Discovers the health in percent for a battery. |
| Commands |
< GET x BATT_HEALTH > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes |
Numeric, three characters 000 - 100 : Percentage of health 254 : An error has occurred, the value is not applicable at this time 255 : Unknown |
| Description | Discovers the state of a battery. |
| Commands |
< GET x BATT_STATE > < REP x BATT_STATE FULL > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes | Fixed String
|
| Description | Discovers the temperature in Celsius. |
| Commands |
< GET x BATT_TEMP_C > There is an offset of 40 so the actual value = 55 - 40 = 15° C. |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes | The actual value = the reported value - 40 Numeric, three characters 000 - 253 : Temperature in Celsius 254 : An error has occurred, the value is not applicable at this time 255 : Unknown |
| Description | Discovers the temperature in Fahrenheit. |
| Commands |
< GET x BATT_TEMP_F > There is an offset of 40 so the actual value = 95 - 40 = 50° F. |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes | The actual value = the reported value - 40 Numeric, three characters 000 - 253 : Temperature in Fahrenheit 254 : An error has occurred, the value is not applicable at this time 255 : Unknown |
| Description | Discovers the number of minutes for a battery to reach the target charging level. |
| Commands |
< GET x BATT_TIME_TO_FULL > < REP x BATT_TIME_TO_FULL 65533 > < REP x BATT_TIME_TO_FULL 65535 > |
| Variables |
Where x is the bay number. Using 0 returns information for all bays. |
| Notes | Numeric, five characters Considered as time to target where:
00000 - 65528: Number of minutes estimated to reach the target 65529 : Battery is fully charged 65533 : Calculation in progress 65534 : Error has occurred 65535 : Unknown or not applicable |
Publications