Command structure, Appendices ~ appendix c: serial commands, Example – ClearOne AP10 User Manual
Page 26
Appendices
~ Appendix C: Serial Commands
22
Technical Services Group ~ 1-800-283-5936 (USA) ~ 1-801-974-3760
Convention
Description
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.
EREF
Words in uppercase bold indicate command text.
DEVICE
Indicates the device type and device number on the G-Link
network. It is composed of a device type number and a device
number. The device type for the AP10 is always 2 and the device
ID will always be 0–0–9, A–F (where A=10 and F=15), or * (to
select all AP10 units).
Command structure
Commands can be either UPPERCASE or lowercase. Also, extra spaces or tabs
between arguments in text commands is allowed. Return values are always in
uppercase. 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: #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
Example
A command to enable auto-answer on the AP10 device “0” has the command line:
#20 AA 1 1. In this command line, 2=AP10, 0=unit 0, AA=command, 1=Telco
channel 1, 1=on state. If a command calls for a “null” value, leave a blank in the
command line. For example, “#20 AA” returns the current auto-answer state on
device 20.
For a command to be recognized by the serial port, it must be terminated by a
carriage return.