The Microflex® Wireless 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. 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.
Most parameters will send a REPORT command then they change. Thus, it is not necessary to constantly query battery or button status parameters. The APT will send a REPORT command when any of these parameters change. Almost all commands are sent back and forth to the APT. The APT then relays these commands to the microphones. Thus, for control, simply send commands to the IP address associated with the APT.
The character "x" in all of the following strings represents the channel and can be ASCII numbers 0 through 8 as in the following table.
0 | All channels |
1 through 8 | Individual channels |
When a microphone is not available (TX_AVAILABLE = NO), its parameters can change. Therefore, the best practice is to monitor TX_AVAILABLE. When TX_AVAILABLE changes from NO to YES, send GET commands for these parameters for the appropriate channel.
Example:
< REP 1 TX_AVAILABLE NO >
< REP 1 TX_AVAILABLE YES >
< GET 1 TX_STATUS >
< GET 1 AUDIO_GAIN >
< GET 1 BATT_RUN_TIME >
< GET 1 BATT_CHARGE >
< GET 1 BATT_HEALTH >
< GET 1 BUTTON_STS >
< GET 1 LED_STATUS >
< GET 1 TX_TYPE >
< REP 1 TX_STATUS ACTIVE >
< REP 1 AUDIO_GAIN 034 >
< REP 1 BATT_RUN_TIME 00317 >
< REP 1 BUTTON_STS OFF >
< REP 1 LED_STATUS ON OFF >
< REP 1 TX_TYPE MXW6 >
To control the LED on the microphone, make certain that “External LED Control” is selected in the MXW GUI.
Note: For gooseneck microphones, there is a separate selection between MX400 Series Bi-color LED or MX400R Series Red LED.
The MXW wireless system is an excellent choice for teleconferencing applications. The echo cancellers/mixers used in these applications require that:
To provide this functionality with the MXW system, select the Preferences tab from the MXWAPT web app. Change the Mute Preference to External Mute.
Note: When using External Mute, the switch behavior (toggle vs latching) is determined by the Crestron/AMX code.
Example 1: Momentary (Push-To-Talk) Button
< REP 1 BUTTON_STS ON >
< SET 1 LED_STATUS OF ON >
(Turns off red LED, turns on green LED for Mic #1)< REP 1 BUTTON_STS OFF >
Control system sends command to mixer to mute channel 1.< SET 1 LED_STATUS ON OF >
(Turns on RED LED, turns off Green LED for Mic #1)Example 2: Latching Mute Switch
< REP 1 BUTTON_STS ON >
< REP 1 BUTTON_STS OFF >
Control system sends command to mixer to mute channel 1.< SET 1 LED_STATUS ON OF >
(Turns on RED LED, turns off Green LED for Mic #1)< REP 1 BUTTON_STS ON >
APT sends:< REP 1 BUTTON_STS OFF >
Control system sends command to mixer to unmute channel 1.< SET 1 LED_STATUS OF ON >
(Turns off RED LED, turns on Green LED for Mic #1)Description | Control for the channel name. |
Commands | Primary channel commands: < GET x CHAN_NAME > < GET SEC x CHAN_NAME > |
Variables |
Where x is channel number: 1, 2, 3, 4, 5, 6, 7, or 8. Where the repeating y represents or pads the 31-character string from the set: A-Z,a-z,0-9,!"#$%&'()*+,-./:;<=>?@[\]^_`~ and space, that is, {1234567890123456789012345678901}. |
Notes |
SET only supports 8 characters. The device always responds with a 31-character name. |
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 | Unlink any mic in any charger from any APT |
Commands | Unlink legacy or primary microphone: < SET x UNLINK > < SET zzz x UNLINK > |
Variables | where x is APT channel or charger bay x takes on value 1-8 depending on APT channel capacity 0 (i.e. "all channels") is not allowed for consistency with the REMOTE_LINK commands zzz = PRI or SEC, where PRI is for the primary mic and SEC is for the secondary mic. |
Notes | If the linked transmitter is off, or on a non-networked charger, it does not receive the unlink, but will not be able to reconnect to the APT channel. The command succeeds, give success message. |
Description | Controls the flash to identify a device or channel. |
Commands | Flash lights on primary device or channel: < SET FLASH ON > < SET SEC FLASH ON > < REP FLASH OFF > Note: When used with no channel index the command initiates a Device Identify. When used with a channel index the command initiates a Channel Identify. < SET x FLASH ON > < SET SEC x FLASH ON > |
Variables | When used, x is the channel number. |
Notes | None. |
Description | Controls the meter rate. |
Commands | Primary mics: < SET x METER_RATE sssss > < SET SEC x METER_RATE sssss > |
Variables |
|
Notes |
00100 - Sample every 100 millisecond (10 samples per sec) 01000 - Sample every second 05000 - Sample every 5 seconds |
These commands are to be sent to the MXWAPT IP address.
Description | Discovery of available transmitters. |
Commands | Get primary transmitter available: < GET x TX_AVAILABLE > < GET SEC x TX_AVAILABLE > |
Variables | Where x is the channel number. |
Notes | A microphone is not available when it is off, unlinked, or is still trying to establish communication after being turned on or undocked. |
Description | Discover and set the transmitter status. |
Commands | Discover primary transmitter status: < GET x TX_STATUS > < SET x TX_STATUS ACTIVE > < GET SEC x TX_STATUS > < SET SEC x TX_STATUS ACTIVE > |
Variables | Where x is the channel number. |
Notes |
|
Description | Control for the channel audio gain. |
Commands | Primary audio gain: < GET x AUDIO_GAIN > < GET SEC x AUDIO_GAIN > There is an offset of 25 so the actual value = 40 - 25 = 15 dB. To set to 22 dB: < SET x AUDIO_GAIN 47 > < SET SEC x AUDIO_GAIN 47 > To decrement the value down 5 dB: < SET x AUDIO_GAIN DEC 5 > < SET SEC x AUDIO_GAIN DEC 5 > To increment the value up 10 dB: < SET x AUDIO_GAIN INC 10 > < SET SEC x AUDIO_GAIN INC 10 > |
Variables | Where x is the channel number. |
Notes |
|
Description | Control for the internal microphone gain. |
Commands | Primary audio gain: < GET x INT_AUDIO_GAIN > Secondary audio gain: < GET SEC x INT_AUDIO_GAIN > There is an offset of 25 so the actual value = 30 - 25 = 5 dB. To set to 12 dB: < SET x INT_AUDIO_GAIN 37 > < SET SEC x INT_AUDIO_GAIN 37 > To decrement the value down 10 dB: < SET x INT_AUDIO_GAIN DEC 10 > < SET SEC x INT_AUDIO_GAIN DEC 10 > To increment the value up 5 dB: < SET x INT_AUDIO_GAIN INC 5 > < SET SEC x INT_AUDIO_GAIN INC 5 > |
Variables | Where x is the channel number. |
Notes |
|
Description | View the microphone button status. |
Commands | Primary microphone button status: < GET x BUTTON_STS > < GET SEC x BUTTON_STS > |
Variables | Where x is the channel number. |
Notes | Sent when the user pushes the button on the microphone. On=pressed, Off=released. The APT will always send this report when the button status changes. There is no need to continually send the GET command. |
Description | Get and set the microphone LED status. |
Commands | Primary microphone LED status: < GET x LED_STATUS > < SET x LED_STATUS rr gg > < GET SEC x LED_STATUS > < SET SEC x LED_STATUS rr gg > |
Variables |
|
Notes | rr and gg can take on the following 2 digit values:
|
Description | Determine the microphone type |
Commands | Primary microphone type: < GET x TX_TYPE > < GET SEC x TX_TYPE > |
Variables | Where x is the channel number. |
Notes | None |
Description | Determine the setting for the audio input source |
Commands | Primary microphone type: < GET x BP_MIC_SELECT > < GET SEC x BP_MIC_SELECT > |
Variables | Where x is the channel number. |
Notes |
|
Description | Discovery of the transmitter battery charge. |
Commands | Primary battery charge status: < GET x TX_BATT_CHARGE > < GET SEC x TX_BATT_CHARGE > |
Variables |
|
Notes | Numeric, 3-character fixed output 000 to 100 - Percent 255 - Device is off |
Description | Discovery of the transmitter battery runtime in minutes. |
Commands | Primary battery runtime: < GET x BATT_RUN_TIME > < GET SEC x BATT_RUN_TIME > |
Variables |
|
Notes |
When microphone is powered by a wall wart charger, yyyyy=65532. When microphone is on the charger, yyyyy=65533. When the run time is still being calculated, yyyyy=65534. When microphone is off, yyyyy=65535. |
Description | Discovery of the transmitter Battery Health. |
Commands | Primary battery health: < GET x BATT_HEALTH > < GET SEC x BATT_HEALTH > |
Variables |
|
Notes | Numeric, 3-character fixed output 000 to 100 - Percent 255 - Unknown |
Description | Discovery of the time remaining until the battery is fully-charged. |
Commands | Primary battery: < GET x BATT_TIME_TO_FULL > < GET SEC x BATT_TIME_TO_FULL > |
Variables |
|
Notes | Numeric, 5-character fixed output When transmitter is off, yyyyy=65535. When transmitter is on and not on the charger, yyyyy=65535. When transmitter is on the charger and fully charged, yyyyy=65534. |
Description | Controls the Transmitter Device ID. |
Commands | Primary channel commands: < GET x TX_DEVICE_ID > < GET SEC x TX_DEVICE_ID > |
Variables | Where x represents the channel number. Where y represents the 12-character string Transmitter Device ID. |
Notes |
|
These commands are to be sent to the MXWNCS IP address.
Note: Additional Charger commands are available to query the status of an unlinked microphone that is being charged. Please contact support@shure.com for assistance.
Description | Link any mic in any charger with any APT |
Commands | Link primary microphone: < SET PRI x REMOTE_LINK y {zzz.zzz.zzz.zzz} > < SET SEC x REMOTE_LINK y {zzz.zzz.zzz.zzz} > |
Variables |
Where x is the number corresponding to the charger bay the transmitter is in. Where y is the number corresponding to the MXWAPT Channel. Where zzz.zzz.zzz.zzz is the IP address of the MXWAPT. |
Notes | Firmware v4.0 or greater. |
Description | Controls the Transmitter Device ID. |
Commands |
< GET x TX_DEVICE_ID > |
Variables | Where x represents the charger bay the transmitter is docked in. Where y represents the 12-character string Transmitter Device ID. |
Notes |
|
All commands adhere to a common set of extra codes, at the upper ends of the binary numbers:
These codes indicate that the device you are trying to control is not available. All commands adhere to a common set of extra codes. The codes are at the upper ends of the binary numbers. The meaning of the codes can be found in the above tables with the appropriate commands.
There is also a < REP ERR > error string that indicates the command is not able to be implemented. This is usually due to a typo or a command that does not exist.