44

Appendices ~ Appendix E: Serial Commands

Commands can be either uppercase or lower case. 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.

For example, a command to disable automatic gain control (AGC) for Mic 2 on AP400 device “0” would have the command line: #30 AGC 2 0. In this command line, 3=AP400, 0=unit 0, AGC=command, 2=mic channel, 0=off state). If a command calls for a “null” value, leave a blank in the command line (for example, “#30 AGC 2” would return the current AGC state of Mic 2 on device 30).

Command Syntax

All command lines in this manual are set off by the symbol “O”. The serial command line that follows the “O” uses the following typographic conventions:

<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 ALL CAPS bold indicate command text

DEVICE

Device type and number on G-Link network. (Valid combinations

 

depend on connected devices. For an AP400, device type is 3, and

 

device ID number will always be 0–7.) If omitted, the product

 

that first receives the command processes it.

*

Can be used to set a parameter on all microphone channels, but it

 

can’t be used to query all mic channels. Note: Using the all-mic

 

toggle might not produce the desired result, depending on the

 

state they are in. For example, if one mic is muted and all other

 

mics are not, an all-mic toggle would mute all others, but unmute

 

that particular mic.

Error Codes

The following lists possible error messages and their explanations:

Error 1

The address is not valid/out of range or an invalid character.

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.

Technical Services Group ~ 1-800-283-5936 (USA) ~ 1-801-974-3760

Page 48
Image 48
ClearOne comm AP400 operation manual Command Syntax, Error Codes, Mref, Device