The ULX-D device is connected via Ethernet to a control system, such as
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 property. After the AMX/Crestron sends a GET command, the system responds with a REPORT string |
SET | Changes the status of a property. After the AMX/Crestron sends a SET command, the system responds with a REPORT string to indicate the new value of the property. |
REP | When the system receives a GET or SET command, it replies with a REPORT command to indicate the status of the property. REP ERR occurs when a command is improperly formatted or when the values are out of range. Important: With the exception of the metered properties, the device sends a REPORT when a value changes. Thus, it is not necessary to constantly query most device properties. |
SAMPLE | Used for metering audio levels. |
All messages sent and received are ASCII. Note that the level indicators and gain indicators are also in ASCII
The character "x" in all of the following strings represents the channel and can be ASCII numbers 0 through 4 as in the following table.
0 | All channels |
1 through 4 | Individual channels |
Description | Discovery of all report strings for the selected channel(s). |
Commands |
< GET x ALL > |
Variables | When x is zero, the device responds with REP for all device-specific properties and ALL channel-related properties including all metered properties. When x is a channel number, the device responds with REP for all device-specific properties and ALL channel x-related properties including all metered properties. |
Notes |
This group is only sent once on receipt of the GET ALL command. Examples: < REP x METER_RATE #### > |
Description | Controls device-based audio summing mode. |
Commands |
< GET AUDIO_SUMMING_MODE > |
Variables | None. |
Notes | Values can be:
|
Description | Controls the device ID. |
Commands |
< GET DEVICE_ID > |
Variables | Where the repeating y represents or pads the 8-character string |
Notes | A blank string represents an unknown device ID. |
Description | Controls the encryption mode. |
Commands |
< GET ENCRYPTION > < SET ENCRYPTION setting > |
Variables | None. |
Notes | Valid values for setting are:
|
Description | Controls the regeneration of the encryption key. |
Commands |
< SET ENCRYPTION_REGENERATE_KEY value > |
Variables | None. |
Notes |
Examples: < SET ENCRYPTION_REGENERATE_KEY REQUESTED > SET generates three responses. When the command is accepted:< REP ENCRYPTION_REGENERATE_KEY REQUESTED > When the new key is created:< REP ENCRYPTION_REGENERATE_KEY COMPLETED > When the receiver is ready to accept a new request:< REP ENCRYPTION_REGENERATE_KEY INACTIVE > |
Description | Controls the flash to identify a device or channel. |
Commands |
< SET FLASH ON > < REP FLASH OFF > When used with a channel index, the command initiates a Channel Identify. < SET x FLASH ON > |
Variables | When used, x is the channel number. |
Notes |
No REP once the flashing has completed. Flash rate and pattern is fixed and device specific. |
Description | Controls device-based frequency diversity mode. |
Commands |
< SET FREQUENCY_DIVERSITY_MODE status > |
Variables | None. |
Notes | Values for the status can be:
|
Description | Discovers the firmware version. |
Commands | Self test passed: < GET FW_VER > |
Variables |
None. |
Notes |
|
Description | Controls high-density mode. |
Commands |
< SET HIGH_DENSITY value > < GET HIGH_DENSITY > < REP HIGH_DENSITY value > |
Variables | None. |
Notes |
Values can be:
|
Description | Discovery of the device model name. |
Commands |
< GET MODEL > |
Variables | None. |
Notes |
Format: 32-character string. |
Description | Discovers the Dante device name on dual and quad devices. |
Commands |
< GET NA_DEVICE_NAME > |
Variables | None. |
Notes | The device always responds with 31-character ID. In these examples, the repeating y pads these strings, representing white space. Getting the Dante Device Name from a ULXD4Q that uses Yamaha naming conventions: < GET NA_DEVICE_NAME > < GET NA_DEVICE_NAME {GuitarRig3} > |
Description | Controls the scan lock. |
Commands |
< GET SCAN_LOCK > |
Variables | None. |
Notes |
When SCAN_LOCK is ON:
|
Description | Controls the sync lock. |
Commands |
< GET SYNC_LOCK > |
Variables | None. |
Notes | When SYNC_LOCK is ON:
|
Description | Control for the network settings. |
Commands |
< GET NET_SETTINGS interface > < REP NET_SETTINGS interface ipMode ipAddr subnetMask gwAddr macAddr > < SET NET_SETTINGS interface ipMode ipAddr subnetMask gwAddr > |
Variables |
|
Notes |
|
Examples |
Example of getting the current network settings for the Shure Control interface: < GET NET_SETTINGS SC > < REP NET_SETTINGS SC AUTO 192.168.001.025 Example of setting the Shure Control network settings to MANUAL settings: < SET After you change the Shure Control network settings you must reconnect at the new IP address. Then you can get/confirm the new settings. < GET < REP NET_SETTINGS SC MANUAL 192.168.001.123 255.255.255.000 192.168.001.001 00:0E:DD:45:60:EB Example of setting the Shure Control network settings to AUTO settings: < SET NET_SETTINGS SC AUTO na na na > After you change the Shure Control network settings you must reconnect at the new IP address. Then you can get/confirm the new settings. < GET < REP NET_SETTINGS SC AUTO 192.168.001.021 255.255.255.000 000.000.000.000 00:0E:DD:45:60:EB Example of setting the Dante Primary interface to manual network settings: < SET NET_SETTINGS D1 MANUAL 10.10.1.15 255.255.255.0 After the reboot you must reconnect, then you can get/confirm the new settings. < GET NET_SETTINGS D1 > < REP NET_SETTINGS D1 MANUAL 010.010.001.015 |
Description | Control for the channel audio gain. |
Commands |
< GET x AUDIO_GAIN > < SET x AUDIO_GAIN # > To decrement the value: < SET x AUDIO_GAIN DEC # > To increment the value: < SET x AUDIO_GAIN INC # > |
Variables | Where x is the channel number and # represents dB. |
Notes |
|
Description | Controls the channel audio mute output. |
Commands |
< GET x AUDIO_MUTE > |
Variables | Where x is the channel number. |
Notes | TOGGLE switches between ON and OFF. |
Description | Control for the channel name. |
Commands |
< GET x CHAN_NAME > |
Variables |
Where x is the channel number. Where the repeating y represents or pads the 8-character string from the set: A-Z,a-z,0-9,!"#$%&'()*+,-./:;<=>?@[\]^_`~ and space. |
Notes |
The device always responds with a 8-character name. |
Description | Discovers an encryption mismatch status. |
Commands |
< GET x ENCRYPTION_WARNING > |
Variables | Where x is the channel number. |
Notes | Values for status are: OFF - No mismatch detected ON - Mismatch detected. |
Description | Controls frequency settings. |
Commands |
< SET x FREQUENCY ###### > |
Variables |
Where x is the channel, ###### is the frequency in KHz, gg is group, cc is channel. |
Notes |
|
Description | Controls the group and channel. |
Commands |
< SET x GROUP_CHAN gg,cc > < GET x GROUP_CHAN > < REP x FREQUENCY ###### > < REP x GROUP_CHAN gg,cc > |
Variables | Where:
|
Notes |
|
Description | Discovers Network Audio (Dante) channel name for dual and quad devices. |
Commands |
< GET x NA_CHAN_NAME > |
Variables |
Where x is the channel number. Where the repeating y pads the 31-character channel name with spaces. |
Notes | None. |
Description | Reports when interference is detected. |
Commands |
< GET x RF_INT_DET > < REP x RF_INT_DET status > |
Variables | Where x is the channel number. |
Notes | Valid values for status are: NONE - No interference detected CRITICAL - Interference detected |
The Shure approach is to use metering to periodically sample your channels and devices:
The SAMPLE command packs multiple attributes into a single message.
You can control the interval of the messages by setting the METER_RATE.
The following sections detail METER_RATE and SAMPLE followed by the set of metered attributes.
Description | Controls the meter rate and reports sampled data. |
Commands |
< GET x METER_RATE > < SET x METER_RATE ##### > < REP x METER_RATE ##### > < SAMPLE x ALL nn aaa eee > |
Variables |
|
Notes |
< SET x METER_RATE 00000 > |
Description | Discovers RF antenna status and receiver squelch status. |
Commands |
< GET x RF_ANTENNA > < REP x RF_ANTENNA nn > |
Variables |
|
Notes | This is a metered property. It does not generate a report on a value change. Receiver squelch status:
|
Description | Discovers the RF received level. |
Commands |
< GET x RX_RF_LVL > |
Variables | Where x is the channel. |
Notes |
|
Description | Discovery of the receiver RMS audio level. |
Commands |
< GET x AUDIO_LVL > |
Variables | Where x is the channel number and ### is a 3-digit number between 000 and 255. |
Notes |
|
Description | Discovers the battery bars. |
Commands |
< GET x BATT_BARS > |
Variables | Where x is the channel number and ### are the bars. |
Notes |
Numeric, 3-character fixed output 000 to 005 - remaining charge 255 - Unknown |
Description | Discovers the charge left in rechargeable batteries. |
Commands |
< GET x BATT_CHARGE > |
Variables | Where x is the channel number and ### represents the percent of charge remaining. |
Notes |
Numeric, 3-character fixed output 000 to 100 - Percent 255 - Unknown |
Description | Discovers the number of battery cycles as reported via side channel. |
Commands |
< GET x BATT_CYCLE > |
Variables | Where x is the channel number and ##### is the cycle count of full charges. |
Notes |
Numeric, 5-character fixed output 00000 to 65534 - Number of cycles 65535 - Unknown |
Description | Discovers the battery health of rechargeable batteries. |
Commands |
< GET x BATT_HEALTH > |
Variables | Where x is channel number and ### is the battery health in percent. |
Notes |
Numeric, 3-character fixed output 000 to 100 - Percent 255 - Unknown |
Description | Discovers the minutes of run time remaining in a rechargeable microphone battery. |
Commands |
< GET x BATT_RUN_TIME > |
Variables | Where x is the channel number and ##### is the remaining run time. |
Notes |
Valid only for microphone units in use, in-range, and out of charger. Numeric, 5-character fixed output00000 to 65532 - Number of minutes of runtime 65533 - Battery communication error 65534 - Battery time calculating 65535 - Unknown, or not applicable Reports when data becomes known. For example, 2 hours 5 minutes would be: < REP x BATT_RUN_TIME 00125 > |
Description | Discovers the battery temperature in Celsius. |
Commands |
< GET x BATT_TEMP_C > |
Variables | Where x is the channel number and ### is the temperature offset by 40. |
Notes |
|
Description | Discovers the battery temperature in Fahrenheit. |
Commands |
< GET x BATT_TEMP_F > |
Variables | Where x is the channel number and ### is the temperature offset by 40. |
Notes |
|
Description | Discovers the battery type. |
Commands |
< GET x BATT_TYPE > |
Variables | Where x is the channel number. |
Notes |
GET supports determination of battery remaining minutes. Values for batt can be:
|
Description | Discovers the transmitter's Device ID. |
Commands |
< GET x TX_DEVICE_ID > |
Variables |
Where x is the channel number. Where the repeating y represents or pads the 8-character string |
Notes |
8-character string - Device ID of the transmitter being received Blank, all spaces - Unknown, not applicable, or there is no transmitter |
Description | Discovers the transmitter firmware version. |
Commands |
< GET x TX_FW_VER > |
Variables |
|
Notes |
|
Description | Discovers the transmitter menu lock status. |
Commands |
< GET x TX_MENU_LOCK > |
Variables | Where x is the channel number. |
Notes | Valid values for status are:
|
Description | Discovers the transmitter mute button status of ULXD6 and ULXD8 transmitters. |
Commands |
< GET x TX_MUTE_BUTTON_STATUS > |
Variables | Where x is the channel index. |
Notes | Values for status are:
|
Description | Discovers the transmitter mute status of the ULXD6 and ULXD8 transmitters. |
Commands |
< GET x TX_MUTE_STATUS > |
Variables | Where x is the channel number. |
Notes |
Values for status are:
|
Description | Discovery of the transmitter offset. |
Commands |
< GET x TX_OFFSET > |
Variables | Where x is the channel number. |
Notes |
Numeric, 3-character fixed Range - 000 to 033 255 - Unknown The actual value = the reported value - 12. This means that the actual range is -12 to +21 dB in 1 dB increments. |
Description | Discovers the power source of the ULXD6 and ULXD8 transmitters. |
Commands |
< GET x TX_POWER_SOURCE > < REP x TX_POWER_SOURCE value > |
Variables | Where x is the channel number. |
Notes | Values can be:
|
Description | Discovers the transmitter power lock status. |
Commands |
< GET x TX_PWR_LOCK > |
Variables | Where x is the channel number. |
Notes | Values for status can be:
|
Description | Discovers the transmitter RF power. |
Commands |
< GET x TX_RF_PWR > < REP x TX_RF_PWR pwr > |
Variables | Where x is the channel number. |
Notes. | Values for pwr can be:
|
Description | Discovers the transmitter type. |
Commands |
< GET x TX_TYPE > |
Variables | Where x is the channel number. |
Notes |
Values for model can be:
|