ClearOne Converge 590 - Manual (Page 77)

Appendix 83
SERIAL COMMANDS
The Converge 560 and Converge 590 accept serial commands through telnet, RS-232
serial port or USB. The commands in this manual pertain only to the Converge 560 and
Converge 590. RS-232 serial port protocol is 9,600, 19,200, 38,400, 57,600 (default) or
115,200 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 Description
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.
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]
#
indicates the start of a command line
DEVICE represents the device type and device number
COMMAND is the command text
[X] [X] represents any additional options in the order that they appear in the
command descriptions that follow
* placed in the Type ID or Device ID fields, the command applies to all
units or all devices respectively.
Example:
A command to disable automatic gain control for Mic 2 on a Converge 560 device “0” will
have the command line: #C0 AGC 2 M 0. In this command line, C=Converge 560, 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, “#C0 AGC 2 M” will return
the current AGC state of Mic 2 on device C.
Command responses will have a carriage return line feed. For example, #C0 AGC 2 M O
carriage return line feed.