ClearOne comm GT1524 SONAR User Manual


 
21
Appendix C ~ Serial Commands
Technical Services Group ~ 1-800-283-5936 (USA) ~ 1-801-974-3760
The GT1524 accepts serial commands through the serial port. The commands in this
manual pertain only to the GT1524. RS-232 serial port protocol is 9,600 (default),
19,200, or 38,400 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
<X> Parameters enclosed in < > indicate a mandatory parameter.
[X] Parameters enclosed in [ ] indicate an optional parameter.
1-8 Parameters separated by a - indicate a range between the values.
4,7,9 Parameters separated by a , indicate a list of available values.
MREF
Words in uppercase bold indicate command text.
Command structure
Commands can be either UPPERCASE or lowercase. Also, extra spaces or tabs
between arguments in text commands are allowed. Return values are always in
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:
COMMAND
[X] [X]
COMMAND
is the command text
[X] [X] represents any additional options in the order that they appear in
the command descriptions that follow
Error codes
Error 1 (Future)
Error 2 Could not extract a command from the string received
Error 3 Serial overrun
Error 4 Reserved
Error 5 Invalid parameter
Error 6 Unrecognized command
Appendix C: Serial Commands