MXCWAPT Microflex® Complete Wireless Command Strings

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

Conventions

There are 4 types of strings:

GET Finds the status of a parameter. After the AMX/Crestron sends a GET command, the device responds with a REPORT string
SET Changes the status of a parameter. After the AMX/Crestron sends a SET command, the device will respond with a REPORT string to indicate the new value of the parameter.
REP When the device receives a GET or SET command, it will reply with a REPORT command to indicate the status of the parameter. REPORT is also sent by the device when a parameter is changed on the MXCWAPT, through the GUI, or a conference unit.
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 when they change. Thus, it is not necessary to constantly query parameters. The device will send a REPORT command when any of these parameters change.

Indexing

Indexing is used to specifically identify upon what the command string is acting.

0 All Channels / All Seat Numbers
1 through 1 Aux Input
1 through 1 Aux Output
1 through 10 Dante Input
1 through 10 Dante Output
1 through 4000 Seat Number

Command Strings

MIC_STATUS

Description Retrieve and control microphone status
Supported Commands GET, SET, and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

Using a value of 0 is only applicable to the GET command.

The GET command with an index of 0 will GET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

OFF

ON

Examples If device is available:

< GET 2 MIC_STATUS >
< REP 2 MIC_STATUS OFF >

< SET 5 MIC_STATUS ON >
< REP 5 MIC_STATUS ON >

If mic is enabled via another source other than TPCI:

< REP 1 MIC_STATUS ON >

If device is registered, but unavailable:

< GET 2 MIC_STATUS >
< REP 2 MIC_STATUS UNKNOWN >

< SET 5 MIC_STATUS ON >
< REP 5 MIC_STATUS UNKNOWN >

SPEAK_REQUEST

Description Control speaker requests
Supported Commands SET
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

Using a value of 0 is NOT accepted.

Values

TRUE

Examples If operation mode is automatic and speaker list is NOT full:

< SET 2 SPEAK_REQUEST TRUE >
< REP 2 SPEAK_LIST_STATUS IN_LIST >

If operation mode is manual and request list is NOT full:

< SET 2 SPEAK_REQUEST TRUE >
< REP 2 REQUEST_LIST_STATUS IN_LIST >

If device is registered, but unavailable:

< SET 2 SPEAK_REQUEST TRUE >
< REP 2 SPEAK_REQUEST UNKNOWN >

SPEAK_RELEASE

Description Release speakers in list
Supported Commands SET
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

Using a value of 0 is NOT accepted.

Values

TRUE

Examples If in speaker list:

< SET 2 SPEAK_RELEASE TRUE >
< REP 2 SPEAK_LIST_STATUS NOT_IN_LIST >

If in request list:

< SET 2 SPEAK_RELEASE TRUE >
< REP 2 REQUEST_LIST_STATUS NOT_IN_LIST >

If device is registered, but unavailable:

< SET 2 SPEAK_RELEASE TRUE >
< REP 2 SPEAK_RELEASE UNKNOWN >

Specified seat number is NOT in speaker or request list (no response given):

< SET 2 SPEAK_RELEASE TRUE >

ALL_DELEGATE_MIC_OFF

Description Turn all delegate microphones off
Supported Commands SET
Indexing None
Values

TRUE

Examples

< SET ALL_DELEGATE_MIC_OFF TRUE >
< REP 1 MIC_STATUS OFF >
< REP 2 MIC_STATUS OFF >

EXCLUSIVE_MUTE

Description Assign exclusive mute
Supported Commands SET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

Using a value of 0 is NOT accepted.

The seat number requesting exclusive mute must correspond to a seat number assigned to a chairman.

Values

OFF

ON

Examples Acquire exclusive mute if the chairman is NOT already in the speaker list:

< SET 1 EXCLUSIVE_MUTE ON >
< REP 1 EXCLUSIVE_MUTE ON >
< REP GLOBAL_MUTE ON >
< REP 1 SPEAK_LIST_STATUS IN_LIST >

Release exclusive mute if no other chairman is holding global mute:

< SET 1 EXCLUSIVE_MUTE OFF >
< REP 1 EXCLUSIVE_MUTE OFF >
< REP GLOBAL_MUTE OFF >
< REP 1 SPEAK_LIST_STATUS NOT_IN_LIST >

Does NOT acquire exclusive mute (no response given; seat is not a chairman or another chairman already holds exclusive mute):

< SET 1 EXCLUSIVE_MUTE ON >

If device is registered, but unavailable:

< SET 1 EXCLUSIVE_MUTE ON >
< REP 1 EXCLUSIVE_MUTE UNKNOWN >

GLOBAL_MUTE

Description Control global mute
Supported Commands GET, SET, and REP
Indexing None

Note: The REP reflects whether the global mute state has been taken by any controller (including TPCI). There can be more than one controller which simultaneously holds the global mute.

Values

OFF

ON

Examples

< GET GLOBAL_MUTE >
< REP GLOBAL_MUTE OFF >

Acquire global mute:

< SET GLOBAL_MUTE ON >
< REP GLOBAL_MUTE ON >

Release global mute:

< SET GLOBAL_MUTE OFF >
< REP GLOBAL_MUTE OFF >

REQUEST_LIST_STATUS

Description Search status of seats in request list
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET command with an index of 0 will GET ALL seat numbers of registered devices.

Values

NOT_IN_LIST

IN_LIST

Examples

< GET 1 REQUEST_LIST_STATUS >
< REP 1 REQUEST_LIST_STATUS NOT_IN_LIST >

SPEAK_LIST_STATUS

Description Search status of seats in speaker list
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET command with an index of 0 will GET ALL seat numbers of registered devices.

Values

NOT_IN_LIST

IN_LIST

Examples

< GET 1 SPEAK_LIST_STATUS >
< REP 1 SPEAK_LIST_STATUS NOT_IN_LIST >

CLEAR_REQUEST_LIST

Description Clear seats from request list
Supported Commands SET
Indexing None
Values

TRUE

Examples

< SET CLEAR_REQUEST_LIST TRUE >
< REP 1 REQUEST_LIST_STATUS NOT_IN_LIST >
< REP 2 REQUEST_LIST_STATUS NOT_IN_LIST >

NEXT_MIC_ON

Description Turn next microphone in request list on
Supported Commands SET
Indexing None
Values

TRUE

Examples

< SET NEXT_MIC_ON TRUE >
< REP 1 REQUEST_LIST_STATUS NOT_IN_LIST >
< REP 1 MIC_STATUS ON >
< REP 1 SPEAK_LIST_STATUS IN_LIST >

MAX_TOTAL_SPEAKERS

Description Set maximum number of speakers allowed
Supported Commands GET, SET, and REP
Indexing None
Values

Format: Numeric

1 character of fixed output

Examples

< GET MAX_TOTAL_SPEAKERS >
< REP MAX_TOTAL_SPEAKERS 2 >

< SET MAX_TOTAL_SPEAKERS 2 >
< REP MAX_TOTAL_SPEAKERS 2 >

MAX_DELEGATE_SPEAKERS

Description Set maximum number of delegate speakers
Supported Commands GET, SET, and REP
Indexing None
Values

Format: Numeric

1 character of fixed output

Examples

< GET MAX_DELEGATE_SPEAKERS >
< REP MAX_DELEGATE_SPEAKERS 3 >

< SET MAX_DELEGATE_SPEAKERS 3 >
< REP MAX_DELEGATE_SPEAKERS 3 >

MAX_NUM_REQUESTS

Description Set maximum number of delegates allowed in request list
Supported Commands GET, SET, and REP
Indexing None
Values

Format: Numeric

1 character of fixed output

Examples

< GET MAX_NUM_REQUESTS >
< REP MAX_NUM_REQUESTS 5 >

< SET MAX_NUM_REQUESTS 5 >
< REP MAX_NUM_REQUESTS 5 >

OPERATION_MODE

Description Retrieve and set operation mode
Supported Commands GET, SET, and REP
Indexing None
Values

AUTO

MANUAL

FIFO

Examples

< GET OPERATION_MODE >
< REP OPERATION_MODE MANUAL >

< SET OPERATION_MODE AUTO >
< REP OPERATION_MODE AUTO >

INTERRUPT_MODE

Description Retrieve and set interruption mode
Supported Commands GET, SET, and REP
Indexing None
Values

NOT_ALLOWED

HIGHER_PRIORITY

EQUAL_AND_HIGHER_PRIORITY

Examples

< GET INTERRUPT_MODE >
< REP INTERRUPT_MODE HIGHER_PRIORITY >

< SET INTERRUPT_MODE NOT_ALLOWED >
< REP INTERRUPT_MODE NOT_ALLOWED >

MIC_PRIORITY

Description Retrieve and set microphone priority
Supported Commands GET, SET, and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET and SET command with an index of 0 will GET and SET ALL seat numbers of registered devices.

Values

Format: Numeric

1 character of fixed output

Examples

< GET 1 MIC_PRIORITY >
< REP 1 MIC_PRIORITY 2 >

< SET 1 MIC_PRIORITY 3 >
< REP 1 MIC_PRIORITY 3 >

LOUDSPEAKER_VOLUME

Description Set the volume of loudspeakers for conference units
Supported Commands GET, SET, and REP
Indexing None
Values

Format: Numeric

3 characters of fixed output

Values REP and SET are offset by 30

Actual_Value = SetOrReportedValue - 30

Actual range: -30 to 6 dB in 1 dB steps

TPCI range: 000 to 036 in steps of 1

Examples

< GET LOUDSPEAKER_VOLUME >
< REP LOUDSPEAKER_VOLUME 004 >

< SET LOUDSPEAKER_VOLUME 12 >
< REP LOUDSPEAKER_VOLUME 012 >

AUX_INPUT_PAD

Description Retrieve and set aux input pad
Supported Commands GET, SET, and REP
Indexing Aux Input

Note: Using the GET and SET commands with an index value of 0 or 1 will GET and SET the aux input.

Values

OFF

ON

Examples

< GET 1 AUX_INPUT_PAD >
< REP 1 AUX_INPUT_PAD OFF >

< SET 1 AUX_INPUT_PAD ON >
< REP 1 AUX_INPUT_PAD ON >

AUX_INPUT_GAIN

Description Retrieve and set aux input gain
Supported Commands GET, SET, and REP
Indexing Aux Input

Note: Using the GET and SET commands with an index value of 0 or 1 will GET and SET the aux input.

Values

Format: Numeric

3 characters of fixed output

Values REP and SET are offset by 30

Actual_Value = SetOrReportedValue - 30

Actual range: -30 to 10 dB in 1 dB steps

TPCI range: 000 to 040 in steps of 1

Examples

< GET 1 AUX_INPUT_GAIN >
< REP 1 AUX_INPUT_GAIN 4 >

< SET 1 AUX_INPUT_GAIN 12 >
< REP 1 AUX_INPUT_GAIN 12 >

AUX_OUTPUT_GAIN

Description Retrieve and set aux output gain
Supported Commands GET, SET, and REP
Indexing Aux Output

Note: Using the GET and SET commands with an index value of 0 or 1 will GET and SET the aux output.

Values

Format: Numeric

3 characters of fixed output

Values REP and SET are offset by 30

Actual_Value = SetOrReportedValue - 30

Actual range: -30 to 0 dB in 1 dB steps

TPCI range: 000 to 030 in steps of 1

Examples

< GET 1 AUX_OUTPUT_GAIN >
< REP 1 AUX_OUTPUT_GAIN 4 >

< SET 1 AUX_OUTPUT_GAIN 12 >
< REP 1 AUX_OUTPUT_GAIN 12 >

MIC_GAIN

Description Control the microphone gain of conference units
Supported Commands GET, SET, and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

Using the GET and SET commands with an index value of 0 will GET and SET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

If AGC is enabled this command will report existing value.

Values

Format: Numeric

3 characters of fixed output

Values REP and SET are offset by 30

Actual_Value = SetOrReportedValue - 30

Actual range: -30 to 10 dB in 1 dB steps

TPCI range: 000 to 040 in steps of 1

Examples If device is available:

< GET 1 MIC_GAIN >
< REP 1 MIC_GAIN 4 >

< SET 1 MIC_GAIN 12 >
< REP 1 MIC_GAIN 12 >

If device is registered, but unavailable:

< GET 1 MIC_GAIN >
< REP 1 MIC_GAIN UNKNOWN >

< SET 1 MIC_GAIN 12 >
< REP 1 MIC_GAIN UNKNOWN >

DANTE_INPUT_GAIN

Description Retrieve and set Dante input gain
Supported Commands GET, SET, and REP
Indexing Dante Input

Note: Using the GET and SET commands with an index value of 0 will GET and SET ALL Dante inputs.

Values

Format: Numeric

3 characters of fixed output

Values REP and SET are offset by 30

Actual_Value = SetOrReportedValue - 30

Actual range: -30 to 10 dB in 1 dB steps

TPCI range: 000 to 040 in steps of 1

Examples

< GET 1 DANTE_INPUT_GAIN >
< REP 1 DANTE_INPUT_GAIN 4 >

< SET 1 DANTE_INPUT_GAIN 12 >
< REP 1 DANTE_INPUT_GAIN 12 >

DANTE_OUTPUT_GAIN

Description Retrieve and set Dante output gain
Supported Commands GET, SET, and REP
Indexing Dante Output

Note: Using the GET and SET commands with an index value of 0 will GET and SET ALL Dante outputs.

Values

Format: Numeric

3 characters of fixed output

Values REP and SET are offset by 30

Actual_Value = SetOrReportedValue - 30

Actual range: -30 to 10 dB in 1 dB steps

TPCI range: 000 to 040 in steps of 1

Examples

< GET 1 DANTE_OUTPUT_GAIN >
< REP 1 DANTE_OUTPUT_GAIN 4 >

< SET 1 DANTE_OUTPUT_GAIN 12 >
< REP 1 DANTE_OUTPUT_GAIN 12 >

AUX_INPUT_AGC

Description Retrieve and set aux input AGC
Supported Commands GET, SET, and REP
Indexing Aux Input

Note: Using the GET and SET commands with an index value of 0 or 1 will GET and SET the aux input.

Values

OFF

ON

Examples

< GET 1 AUX_INPUT_AGC >
< REP 1 AUX_INPUT_AGC ON >

< SET 1 AUX_INPUT_AGC OFF >
< REP 1 AUX_INPUT_AGC OFF >

DANTE_INPUT_AGC

Description Retrieve and set Dante input AGC
Supported Commands GET, SET, and REP
Indexing Dante Input

Note: Using the GET and SET commands with an index value of 0 will GET and SET ALL Dante inputs.

Values

OFF

ON

Examples

< GET 1 DANTE_INPUT_AGC >
< REP 1 DANTE_INPUT_AGC ON >

< SET 1 DANTE_INPUT_AGC OFF >
< REP 1 DANTE_INPUT_AGC OFF >

DANTE_INPUT_MUTE

Description Retrieve and set Dante input mute
Supported Commands GET, SET, and REP
Indexing Dante Input

Note: Using the GET and SET commands with an index value of 0 will GET and SET ALL Dante inputs.

Values

OFF

ON

Examples

< GET 1 DANTE_INPUT_MUTE >
< REP 1 DANTE_INPUT_MUTE ON >

< SET 1 DANTE_INPUT_MUTE OFF >
< REP 1 DANTE_INPUT_MUTE OFF >

DANTE_OUTPUT_MUTE

Description Retrieve and set Dante output mute
Supported Commands GET, SET, and REP
Indexing Dante Output

Note: Using the GET and SET commands with an index value of 0 will GET and SET ALL Dante outputs.

Values

OFF

ON

Examples

< GET 1 DANTE_OUTPUT_MUTE >
< REP 1 DANTE_OUTPUT_MUTE ON >

< SET 1 DANTE_OUTPUT_MUTE OFF >
< REP 1 DANTE_OUTPUT_MUTE OFF >

MIC_AGC

Description Retrieve and set microphone AGC
Supported Commands GET, SET, and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET and SET command with an index of 0 will GET and SET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

OFF

ON

Examples If device is available:

< GET 1 MIC_AGC >
< REP 1 MIC_AGC ON >

< SET 1 MIC_AGC OFF >
< REP 1 MIC_AGC OFF >

If device is registered, but unavailable:

< GET 1 MIC_AGC >
< REP 1 MIC_AGC UKNOWNN >

< SET 1 MIC_AGC OFF >
< REP 1 MIC_AGC UNKNOWN >

FLASH

Description Turn on flash to identify a device
Supported Commands GET, SET, and REP
Indexing No index flashes APT. Index (Seat Number) flashes microphone

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET and SET command with an index of 0 will GET and SET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

OFF

ON

Examples Flash APT:

< GET FLASH >
< REP FLASH ON >

< SET FLASH ON >
< REP FLASH ON >

Flash conference unit if device is available:

< GET 1 FLASH >
< REP 1 FLASH OFF >

< SET 1 FLASH ON >
< REP 1 FLASH ON >

Flash conference unit if device is registered, but unavailable:

< GET 1 FLASH >
< REP 1 FLASH UNKNOWN >

< SET 1 FLASH ON >
< REP 1 FLASH UNKNOWN >

ROLE

Description Retrieve and set role for device
Supported Commands GET, SET, and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET and SET command with an index of 0 will GET and SET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

DELEGATE

CHAIRMAN

LISTENER

AMBIENT

Examples If device is available:

< GET 1 ROLE >
< REP 1 ROLE DELEGATE >

< SET 1 ROLE CHAIRMAN >
< REP 1 ROLE CHAIRMAN >

If device is registered, but unavailable:

< GET 1 ROLE >
< REP 1 ROLE UNKNOWN >

< SET 1 ROLE CHAIRMAN >
< REP 1 ROLE UNKNOWN >

SEAT_NAME

Description Retrieve seat name
Supported Commands GET, SET, and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET and SET command with an index of 0 will GET and SET ALL seat numbers of registered devices.

Values

UTF8 characters are allowed except those used to encapsulate TPCI: {,},<,>

e.g.: {1234567890123456789012345678901}

Fixed character size 31

Examples If NFC card is NOT inserted:

< GET 1 SEAT_NAME >
< REP 1 SEAT_NAME {Bill} >

< SET 1 SEAT_NAME {Doug} >
< REP 1 SEAT_NAME {Doug} >

If NFC card (Card Name = Bill) is inserted:

< GET 1 SEAT_NAME >
< REP 1 SEAT_NAME {Bill} >

< SET 1 SEAT_NAME {Doug} >
< REP ERR >

If NFC card (Card Name = Luke) is inserted and removed:

< GET 1 SEAT_NAME >
< REP 1 SEAT_NAME {Bill} >

* NFC CARD INSERTED *
< REP 1 SEAT_NAME {Luke} >

* NFC CARD REMOVED *
< REP 1 SEAT_NAME {Bill} >

RF_POWER

Description Retrieve and set RF power
Supported Commands GET, SET, and REP
Indexing None
Values

OFF

LOW

MEDIUM

HIGH

MAXIMUM

Examples

< GET RF_POWER >
< REP RF_POWER LOW >

< SET RF_POWER HIGH >
< REP RF_POWER HIGH >

DEVICE_ID

Description Retrieve and set device ID
Supported Commands GET, SET, and REP
Indexing None
Values

Format: Fixed String 31character for REP

1-31 Characters from the set: A-Z,a-z,0-9, and hyphen "-".

Note: The device ID cannot begin or end with the hyphen "-".

Examples

< GET DEVICE_ID >
< REP DEVICE_ID {Bill} >

< SET DEVICE_ID {Doug} >
< REP DEVICE_ID {Doug} >

ALL

Description Retrieve all supported commands
Supported Commands GET and REP
Indexing None
Values None
Examples

< GET ALL >

Responds with REP for all supported commands

BATT_CHARGE

Description View battery charge status
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET command with an index of 0 will GET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

Format: 3 numbers

000-100: Percent status of charge

Examples If device is available:

< GET 5 BATT_CHARGE >
< REP 5 BATT_CHARGE 85 >

If device is registered, but unavailable:

< GET 3 BATT_CHARGE >
< REP 3 BATT_CHARGE UNKNOWN >

BATT_RUN_TIME

Description Monitor battery life
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET command with an index of 0 will GET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

Format: 5 numbers

00000-65535: Corresponds to the minutes until the conference unit turns off, according to the current power level

Examples If device is available:

< GET 1 BATT_RUN_TIME >
< REP 1 BATT_RUN_TIME 00045 >

If device is registered, but unavailable:

< GET 5 BATT_RUN_TIME >
< REP 5 BATT_RUN_TIME UKNOWN

BATT_CYCLE

Description Monitor individual battery cycles
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET command with an index of 0 will GET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

Format: 4 numbers

0000-9999

Examples If device is available:

< GET 2 BATT_CYCLE >
< REP 2 BATT_CYCLE 0006 >

If device is registered, but unavailable:

< GET 5 BATT_CYCLE >
< REP 5 BATT_CYCLE UNKNOWN >

BATT_HEALTH

Description Monitor battery health percentages
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET command with an index of 0 will GET ALL seat numbers of online registered devices. No response is given for seat numbers not referring to online devices.

Values

Format: 3 numbers

000-100: Percent status of health

255: Unknown, or not applicable

Examples If device is available:

< GET 4 BATT_HEALTH >
< REP 4 BATT_HEALTH 098 >

If device is registered, but unavailable:

< GET 1 BATT_HEALTH >
< REP 1 BATT_HEALTH UNKNOWN >

UNIT_AVAILABLE

Description Indicates device is available
Supported Commands GET and REP
Indexing Seat Number

Note:

There are 4000 valid seat numbers, but only some may refer to online registered devices. Indexing seat numbers not referring to online devices may result in no response or in a return value of "UNKNOWN."

The GET comman with an index of 0 will GET ALL seat numbers of registered devices.

Values

AVAILABLE

OFFLINE

NOT REGISTERED

Examples

< GET 1 UNIT_AVAILABLE >
< REP 1 UNIT_AVAILABLE OFFLINE >

AUDIO_METER_RATE

Description Set and view audio metering rate
Supported Commands GET, SET, and REP
Indexing None
Values

Where rate is from 0= off, 100-99999= interval between reported metering samples in milliseconds.

Audio sampling messages are sent periodically at the rate specified in the AUDIO_METER_RATE message.

Examples Audio metering:

< SET AUDIO_METER_RATE 1000 >
< REP AUDIO_METER_RATE 1000 >
< GET AUDIO_METER_RATE >
< REP AUDIO_METER_RATE 1000 >
< AUDIO_SAMPLE auxInPeak auxInRms slot1Peak slot1Rms slot2Peak slot2Rms ... slotXPeak slotXRms >

Where auxInPeak is the aux input peak audio level.

Where auxInRms is the aux input RMS audio level.

Where slot[N]Peak is the uplink slot [n] peak audio level.

Where slot[N]Rms is the uplink slot [n] RMS audio level.

Audio RMS Level is a three digit value, which takes on the value -98 dB to 0 dB offset by 98 (i.e. 000-098). actualAudioRMS = aud - 98

RF_METER_RATE

Description Set and view RF metering rate
Supported Commands GET, SET, and REP
Indexing None
Values

Where rate is from 0= off, 100-99999= interval between reported metering samples in milliseconds.

RF sampling messages are sent periodically at the rate specified in the RF_METER_RATE message.

Examples RF metering:

< SET RF_METER_RATE 1000 >
< REP RF_METER_RATE 1000 >
< GET RF_METER_RATE >
< REP RF_METER_RATE 1000 >
< REP seatNum1 RSSI value1 >
< REP seatNum2 RSSI value2 >
...
< REP seatNumX RSSI valueX >

Where seatNum[N] is the seat number being reported on.

Where value[N]is the average estimated receive signal power, in dBm, at the conference unit.

AUX_INPUT_MUTE

Description Retrieve and set aux input mute
Supported Commands GET, SET, and REP
Indexing Aux Input

Note: Using the GET and SET commands with an index value of 0 or 1 will GET and SET the aux input.

Values

OFF

ON

Examples

< GET 1 AUX_INPUT_MUTE >
< REP 1 AUX_INPUT_MUTE ON >

< SET AUX_INPUT_MUTE OFF >
< REP AUX_INPUT_MUTE OFF >

AUX_OUTPUT_MUTE

Description Retrieve and set aux output mute
Supported Commands GET, SET, and REP
Indexing Aux Output

Note: Using the GET and SET commands with an index value of 0 or 1 will GET and SET the aux output.

Values

OFF

ON

Examples

< GET 1 AUX_OUTPUT_MUTE >
< REP 1 AUX_OUTPUT_MUTE ON >

< SET 1 AUX_OUTPUT_MUTE OFF >
< REP 1 AUX_OUTPUT_MUTE OFF >