ClearOne Interact Serial Command Guide - Manual (Page 7)

Page 2 of 56
CONVENTIONS
This definition uses the following typographic conventions used in this document:
Convention Description
<X> Parameters enclosed in "< >" indicate a mandatory parameter.
[X] Parameters enclosed in "[ ]" indicate an optional parameter.
1-8 Parameters separated by a hyphen ("-") indicate a range between the values.
4,7,9 Parameters separated by a comma "," indicate a list of available values.
BAUD Words in UPPERCASE Bold indicate command text.
DEVICE Indicates the Device Type and Device ID.
General Text Command Form Description
The commands are outlined in the Command table. The structure of serial commands is as follows:
l
# (indicates the start of a command line), Type ID, Device ID, Command, then any additional options in
the order that they appear in the command descriptions on the following pages. Commands can be
either UPPERCASE or lowercase. Return values are always in upper case. In order for a command to
be recognized by the serial port, the command must be terminated by a carriage return.
l
If a ‘*’ is placed in the Type ID or Device ID fields, the command is to apply to all units or all devices
respectively.
l
If a command calls for a “NULL” value, leave a blank in the command line (for example “#80 MUTE 2 I”
would return the current mute state of Mic 2 on device 80).