Serial Commands - ClearOne Tabletop Controller User Manual

SERIAL COMMANDS

The XAP accepts serial commands through the serial port or the expansion bus. RS-232 serial port protocol is
38,400 or 57,600 baud; 8 bits, 1 stop bit, no parity.
CONVENTIONS
The following typographic conventions are used in this document to describe the different serial commands.
Use the Command structure section and the examples as a guide when creating your serial commands.
Convention
<X>
[X]
1-8
4,7,9
EREF
DEVICE
COMMAND STRUCTURE
The following typographic conventions are used in this document to describe the different serial commands.
Use the Command structure section and the examples as a guide when creating your serial commands.
Commands can be either UPPERCASE or lowercase. Also, extra spaces or tabs between arguments in text
commands are allowed. Return values are always uppercase. In order for a command to be recognized by the
serial port, the command must be terminated by a carriage return.
The structure of serial commands is as follows:
#TYPE DEVICE COMMAND [X] [X]
#
DEVICE
COMMAND
[X] [X]
Example:
A command to disable automatic gain control for Mic 2 on a XAP 800 device "0" will have the command line:
#50 AGC 2 M 0. In this command line, 5=XAP 800, 0=unit 0, AGC=command, 2=channel, M=Mic Input
group, 0=off state. If a command calls for a "null" value, leave a blank in the command line. For example,
"#50 AGC 2 M" will return the current AGC state of Mic 2 on device 50.
Command responses will have a carriage return line feed. For example, #50 AGC 2 M O carriage return line
feed.
GROUPS AND CHANNELS
If a channel has an alpha value of "*", the command is to be applied to all channels. For example, a group
value of M and a channel value of "*" means that the command is to be applied to all channels of group M
(mic inputs). Table 5.1 shows the alpha representations for the different groups and the channels that are
available for each product.
20 Technical Services: 800.283.5936
Description
Parameters enclosed in < > indicate a mandatory parameter.
Parameters enclosed in [ ] indicate an optional parameter.
Parameters separated by a hyphen (-) indicate a range between the
values.
Parameters separated by a comma (,) indicate a list of available
values.
Words in uppercase bold indicate command text.
Indicates the device type and device number on the expansion bus network.
indicates the start of a command line
represents the device type and device number
is the command text
represents any additional options in the order that they appear in the command descriptions
that follow