ClearOne Converge Pro Serial User Manual

APPENDIX A: APPLICATION PROGRAMMER’S INTERFACE

TYPE AND DEVICE IDS

Converge/Converge Pro Device Types and Device IDs by model are as follows:

Model Device Type Device ID Range

880 1 0-B

TH20 2 0-F

VH20 E 0-F

840T 3 0-B

8i A 0-B

880T D 0-B

880TA H 0-B

SR 1212 G 0-B

SR 1212A I 0-B

Beamforming

Mic Array

CONVENTIONS

N 0-F

This guide uses the following typographic conventions to describe Converge/Converge Pro serial command syntax:

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 of allowable values

4,7,9 Parameters separated by a ‘,’ indicate a list of allowable values

EREF Words in UPPERCASE bold indicate command text

Device

Indicates the device type and device number on the Expansion Bus. It is composed of a device type character and a device ID character.

COMMAND FORM DESCRIPTION

The structure of serial commands is as follows:

# <Device Type> <Device ID> <Command> [Values] <Carriage Return>

# indicates the start of a command line, the Carriage Return terminates a command.

NOTE: Serial commands can be either UPPERCASE or lowercase. Return values are always in

UPPERCASE. In order for a command to be recognized by the RS-232 serial port, the command must be terminated by a carriage return.

For example, a command to disable mute for Mic Input 5 on a Converge Pro 880 with a Device ID of 2 would have the command line #12 MUTE 5 M 0.

In this command line, 1 = the Device Type for Converge 880, 2 = the Device ID for unit 2, MUTE = serial command, 5 = the channel Value, M = the channel type Value for mic input channels, and 0 = the command Value that turns mute off.

228

If an asterisk (*) is placed in the Device Type or Device ID fields, the command will apply to all units or all devices respectively. For example, a command with a Device Type = 1 and a Device ID = * would apply the command to all Converge 880 units. A command with a Device Type = * and a Device ID = 6 would apply the command to all units with a Device ID of 6.

If a command specifies “(Null to query in text)” in its Value table, leave a blank in the command line to query the current state of that value. For example, the command #12 MUTE 5 M <blank> would return the current mute state of Mic 2 on an 880 unit with a Device ID of 0.

GROUPS AND CHANNELS

All serial commands use common alpha and numeric designators to reference channel groups, channel types, and other command values. Also, different channel groups have different allowable channel ranges, as shown in the following table.

Converge

Group Alpha

Inputs I 1-12 1-2 1-8 1-12 1-12 1-12 1-12 1-2 N/A

Outputs O 1-12 1-2

Mic Input M 1-8 N/A 1-4 1-8 1-8 1-8 1-8 N/A N/A

Beamforming

Mic Array

Amplifier

Output

Gating Group G 1-4, A-F N/A 1-4, A-F 1-4, A-F 1-4, A-F 1-4, A-F 1-4, A-F N/A A-F

Processing P A-F N/A A-D A-F A-F A-F A-F N/A N/A

Expansion Bus Audio

Channels

Line Inputs L 9-12 1-2 5-8 9-12 9-12 9-12 9-12 1-2 N/A

Expansion

Bus

Reference

Channels

GPIO Y 0 0 0 0 0 0 0 0 N/A

Matrix X 0 0 0 0 0 0 0 0 0

Fader F 1-4 N/A 1-4 N/A 1-4 N/A N/A N/A N/A

Presets S 1-32 1-32 1-32 1-32 1-32 1-32 1-32 1-32 N/A

Macros C 1-255 1-255 1-255 1-255 1-255 1-255 1-255 1-255 N/A

Transmit T N/A 1 1 N/A 1 1 N/A N/A N/A

Receive R N/A 1 1 N/A 1 1 N/A N/A N/A

Virtual

Reference

Timed Events Q 1-10 1-10 1-10 1-10 1-10 1-10 1-10 1-10 N/A

Web W 0 0 0 0 0 0 0 0 N/A

PA Virtual

Reference

VoIP Transmit K N/A N/A N/A N/A N/A N/A N/A 1 N/A

VoIP Receive Z N/A N/A N/A N/A N/A N/A N/A 1 N/A

USB Transmit D N/A N/A N/A N/A N/A N/A N/A N/A N/A

USB Receive U N/A N/A N/A N/A N/A N/A N/A N/A N/A

Pro 880 and

SR 1212 Channel

Range

V N/A N/A N/A N/A N/A N/A N/A N/A 1

J N/A N/A N/A N/A N/A 1-4 1-4 N/A N/A

E O-Z, I-N O-Z, I-N O-Z, I-N O-Z, I-N O-Z, I-N O-Z, I-N O-Z, I-N O-Z, I-N O-Z, I-N

A 1-8 1-8 1-8 1-8 1-8 1-8 1-8 1-8 1-8

B 1 – 4 N/A 1 – 4 N/A 1 – 4 1-4 N/A N/A N/A

H N/A N/A N/A N/A N/A 1-4 1-4 N/A N/A

Converge Pro TH20

Channel

Range

Converge

Pro 840T

Channel

Range

1-9 (9 is

the power

amp)

Converge

Pro 8i

Channel

Range

N/A

Converge

880T

Channel

Range

1-13 (13 is

the power

amp)

Converge

880TA

Channel

Range

1-8 1-12 1-2 N/A

Converge SR 1212A

Channel

Range

Converge Pro VH20

Channel

Range

Beam-

forming

Mic Array

Channel

Range

229

METER TYPE DEFINITIONS TABLE

A L P

Mics

H A

I Input level Input level Input level Input level

Level

post-gain

adjustment, but pre-filter

Level post-

filter but

pre-gate

(non-gated

level)

Level post-

gate (gated

level)

Echo Return

Loss (Not

SR 1212 / SR

1212A)

Echo

Return Loss

Enhance-

ment

(Not SR

1212 / SR

1212A)

ERL + ERLE

(Not SR

1212 / SR

1212A)

C AGC N/A AGC N/A N/A N/A

Pre AGC

peak level

meter

Post AGC

peak level

meter

B Ambient N/A N/A N/A N/A N/A N/A N/A N/A

Beam-

forming Mic

Array

Level

post-gain adjustment, but pre-filter

N/A N/A N/A N/A

Level post-

gate (gated

level)

Echo Return

Loss

Echo

Return Loss

Enhance-

ment

ERL + ERLE N/A N/A N/A N/A N/A N/A Adaptive Gain

N/A

Line Inputs Outputs Telco TX Telco Rx Faders Processors Power Amp.

Post Gain

level

N/A N/A N/A N/A N/A N/A

Pre AGC

peak level

meter

Post AGC peak level

meter

Post Gain

Level Position for:

Post Gain

level

N/A N/A N/A N/A N/A

N/A N/A N/A N/A N/A N/A

Post Limiter

level

Input Level N/A

Post Gain

level

Level after

Gain Stage

Level Post

gain Adjust-

ment

N/A

Level into

Compressor

Level Post

Compressor

Level Post

Gain Stage

N/A

Input Level

Post NOM

Output Level

Post Gain

Feedback

Max Auto

Gain

Compressor

Attenuation

Level Pre

Compressor

Level Post

Compressor

Level of

Adaptive Gain

Noise Floor

Level Post

Mute/Gain

Pre EQ

230

SERIAL COMMAND INDEX

AA – Auto Answer Enable / Disable .....................................................237

AAMB – Adaptive Ambient Mode .......................................................237

AARINGS – Number of Rings to Auto Answer On ........................................237

ACONN – Audible Connect / Disconnect Indication.......................................237

ACONNLVL – Audible Connect / Disconnect Level .......................................238

AD – Auto Disconnect Enable / Disable..................................................238

ADCLIP – Audio Clipping ..............................................................238

ADPRESENT – Audio Presence ........................................................239

AEC – Acoustic Echo Cancellation Enable / Disable ......................................239

AGC – Automatic Gain Control .........................................................239

AGCSET – Automatic Gain Control Adjust ...............................................240

AMBLVL – Ambient Level Adjust ........................................................240

AMXDUET – Use AMX Duet Discovery ..................................................240

AUDIOMASTER – Expansion Bus Audio Master Mode....................................240

AV – Adaptive Volume .................................................................240

AVG – Adaptive Volume Gain...........................................................241

AVR – Adaptive Volume Reference......................................................241

AVRT – Adaptive Volume Ratio .........................................................241

AVT – Adaptive Volume Threshold ......................................................241

BAUD – Baud Rate ....................................................................241

BFBINFO – Beamforming Array Beam Information .......................................242

BFLED – Beamforming Mic LED Mode ..................................................243

BFMODE – Sets/Reports Beamforming Mic Mode .......................................242

BFMUTEMACRO – Define Macros When Beamforming Mic Mute Button Is Pressed ........243

BFPOS – Beamforming Array Position in Auto Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

BFZONE – Manually Disables/Enables Beamforming Mic Zones ..........................243

CALLDUR – Call Duration ..............................................................244

CALLERID – Reports Caller ID Information ..............................................244

CALLSTATUS – Report the Status of VoIP Channels......................................296

CGROUP – Compressor Group Select ..................................................244

CHAIRO – Chairman Override Mode ....................................................244

CLEAREFFECT – ClearEffect Wide Band Telco Emulation ................................245

CLOCK – Clock Set ...................................................................245

COMPDLY – Compressor Delay ........................................................245

COMPDLYEN – Compressor Delay Enable ..............................................245

COMPRESS – Compressor Adjust ......................................................246

COMPSEL – Compression Select.......................................................246

CONFCANCEL – Cancels a Conference Call Bridge......................................296

CONFCOMPLETE – Completes a Conference Call Bridge ................................296

CONFSTART – Initiates a 3-Way Conference Call ........................................297

COUNTRY – Country Selection .........................................................246

CTRLMASTER – Control Master Mode ..................................................246

DECAY – Decay Adjust ................................................................247

DEFAULT – Default The Unit ...........................................................247

231

DELAY – Delay Adjust .................................................................247

DELAYSEL – Delay Select..............................................................247

DEVICENAME – Argument Identification Label...........................................247

DEVICESUBTYPE – Sets the Subtype of a Connected Device.............................248

DEVICETYPE – Sets the Type of a Connected Device ....................................248

DFLTM – Default Meter.................................................................248

DIAG – Diagnostic Commands .........................................................248

DIAL – DTMF Dialing ..................................................................248

DID – Device ID .......................................................................249

DTMFLVL – DTMF Tone Level ..........................................................249

DTONELVL – Dial Tone Level ...........................................................249

DUPDATE – Download Update .........................................................249

DVER – Command Dictionary Version...................................................249

ENETADDR – Ethernet Port IP Address..................................................249

ENETDHCP – Ethernet DHCP Selection .................................................250

ENETDNSA2 – Ethernet DNS Server Address 2 .........................................250

ENETDNSA – Ethernet DNS Server Address.............................................250

ENETDNS – Ethernet DNS Selection ....................................................250

ENETDOMAIN – Ethernet Domain Argument ............................................250

ENETGATE – Ethernet Default Gateway Address.........................................250

ENETSUBN – Ethernet Subnet Mask....................................................250

ENETVLAN – Enable VLAN Tagging ....................................................251

ENETVLANID – VLAN ID ...............................................................251

ENETVLANPRI – VLAN Priority .........................................................251

EREF – Expansion Bus Reference ......................................................251

EVENT – Run Scheduled Event .........................................................251

FEB – Feedback Elimination Bandwidth .................................................252

FEDR – Feedback Elimination Dynamic Node Reset......................................252

FE – Feedback Elimination Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

FEF – Feedback Elimination Fixed Filter .................................................252

FEG – Feedback Elimination Auto Gain Max .............................................252

FEGL – Feedback Elimination Gain Level ................................................253

FELD – Feedback Elimination Lock Depth ...............................................253

FEM – Feedback Elimination Mode .....................................................253

FEN – Feedback Elimination Nodes .....................................................253

FER – Feedback Elimination Node Reset ................................................253

FERNG – Feedback Elimination Ring Elimination Mode...................................254

FESC – Feedback Elimination Setup Complete ..........................................254

FES – Feedback Elimination Setup......................................................254

FILTER – Filter Adjust ..................................................................255

FILTSEL – Filter Select .................................................................255

FLOW – Flow Control ..................................................................256

FMP – First Mic Priority Mode...........................................................256

GAIN – Gain Adjustment ..............................................................256

GATE – Gate Status ...................................................................256

232

GHOLD – Gate Hold Time Adjust .......................................................256

GMODE – Gating Mode................................................................257

GPIOSTATUS – General Purpose Status ................................................257

GRATIO – Gate Ratio Adjust............................................................257

GREPORT – Gate Report ..............................................................257

GRPSEL – Gating Group Select ........................................................258

HDAEC – Enables/Disables HD AEC mode ..............................................258

HDAECMODE – Set/Report HD AEC mode ..............................................258

HDDREFSEL1 – Reference Select for Mono Channel Acoustic Echo Cancellation Block .....258

HDDREFSEL2 – Reference Select for Stereo Channel Acoustic Echo Cancellation Block ....258

HDNLP – Non Linear Processing Adjust .................................................259

HOLD – Places a Call on Hold ..........................................................297

HOOKD – Hook Flash Duration .........................................................259

HOOK – Hook Flash ...................................................................259

LABEL – Label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

LCDCONTRAST – LCD Contrast .......................................................259

LMO – Last Mic On Mode ..............................................................260

LOCALNUM – Local Number...........................................................260

LOCBLDG – Location: Building.........................................................260

LOCCITY – Location: City ..............................................................260

LOCCNTRY – Location: Country........................................................260

LOCCOMP – Location: Company.......................................................261

LOCREGION – Location: Region .......................................................261

LOCROOM – Location: Room ..........................................................261

LOCSITENAME – Location: Site Argument ..............................................261

LOCSTATE – Location: State ...........................................................261

LOGMASK – Device Log Mask .........................................................262

LVL – Level ...........................................................................262

LVLREPORTEN – Level Report Enable ..................................................263

LVLREPORT – Level Report ............................................................262

MACRO – Macro Execution/Reporting ..................................................263

MANUFACTURER – Manufacturer Identification Label ....................................263

MAX – Maximum Gain Setting ..........................................................263

MCGAIN – Multi-Channel Gain .........................................................264

MCMINMAX – Multi-Channel Min and max Gain Setting ..................................264

MC – Multi-Channel Mode..............................................................264

MCMUTE – Multi-Channel Min and Max Gain Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

MCRAMP – Multi-Channel Ramp .......................................................265

MINMAX – Minimum and Maximum Gain Setting.........................................265

MIN – Minimum Gain Setting ...........................................................265

MLINE – Mic / Line Coarse Gain Setting .................................................266

MMAX – Maximum Number of Microphones .............................................266

MODEL – Model Identification Label ....................................................266

MTRXCLEAR – Clear Matrix ............................................................267

MTRXLVL – Matrix Attenuation Adjust ...................................................267

233

MTRX – Matrix Routing.................................................................267

MTRXTYPE – Select Pre-AEC Gated or Non-Gated Routing ...............................268

MULTILNEN – VoIP Multi-Line Enable ...................................................297

MULTILNSTAT – VoIP Multi-Line Status .................................................297

MUTE – Mute .........................................................................268

NAME – Unit Name (NETBIOS Name)...................................................268

NCD – Noise Cancellation Depth Adjust .................................................268

NCSEL – Noise Cancellation Select .....................................................268

NLP – Non Linear Processing Adjust . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

NOM – Number of Open Microphones Mode ............................................269

NTPSRV – NTP Network Time Server Address ...........................................269

NULL – Null the Telephone Line ........................................................269

OFFA – Off Attenuation Mode...........................................................269

PAA – PA Adaptive Mode...............................................................270

PACEN – PA Softclipper Enable ........................................................270

PAENERGY – PA Energy-saver mode ...................................................270

PAEQEN – PA EQ Filter Enable .........................................................270

PAEQRST – PA EQ Filter Reset .........................................................271

PAEQSET – PA EQ Filter Set ...........................................................271

PAFLT – PA Fault ......................................................................271

PAIMPED – PA Output Impedance .....................................................271

PALEN – PA Limiter Enable ............................................................272

PALT – PA Limiter Threshold ...........................................................272

PANGAT – PA Noise Gate Activation Timer ..............................................272

PANGEN – PA Noise Gate Enabled .....................................................272

PANGF – PA Noise Gate Filter .........................................................272

PANGM – PA Noise Gate Mode ........................................................273

PANGT – PA Noise Gate Threshold .....................................................273

PAPOL – Polarity Switch ...............................................................273

PARST – PA Reset ....................................................................273

PASME – PA Sound Mask Enable ......................................................273

PASML – PA Sound Mask Level ........................................................274

PASMM – PA Sound Mask Mode .......................................................274

PASMT – PA Sound Mask Timer .......................................................274

PATO – PA Thermal Overload ..........................................................274

PBDIAL – Dial a PB Entry by Argument..................................................274

PHONEBOOKADD – Adds an Entry to the Phonebook ...................................275

PHONEBOOKCNT – Counts Entries in the Phonebook ...................................275

PHONEBOOKDEL – Deletes an Entry in the Phonebook..................................275

PHONEBOOKREAD – Queries the Phonebook by Index..................................275

PP – Phantom Power ..................................................................275

PRESET – Preset Execution/Reporting ..................................................276

PRGSTRING – Program String .........................................................276

PROXYSTAT – Proxy Registration Status ................................................276

PROXYTYPE – Set/Get Proxy Type......................................................276

234

PTTTHRESHOLD – Push to Talk Threshold..............................................277

PUSHTOTALK – Push to Talk ..........................................................277

RAMP – Ramp Gain Adjustment .......................................................277

REDIAL – Redial the Last Number ......................................................277

REFSEL – Reference Select for PA Adaptation & AEC ....................................277

REFSET – Reference Channel Set Up ...................................................278

RESET – Reset .......................................................................278

RINGEREN – Audible Ring Enable......................................................278

RINGERLVL – Audible Ring Level.......................................................278

RINGERSEL – Audible Ring Melody Selection ...........................................278

RINGERTEST – Audible Ring Melody Test...............................................279

RINGMOD – Ring Cadence Mode ......................................................279

RINGOFF – Ring Cadence Off Time ....................................................279

RINGON – Ring Cadence On Time .....................................................279

RING – Ring Indication.................................................................278

RXBOOST – Receive Boost ............................................................280

RXBSTEN – Receive Boost Enable......................................................280

SERECHO – Serial Echo ...............................................................280

SFTYMUTE – Safety Mute..............................................................280

SIGGENEN – Signal Generator Enable ..................................................281

SIGGEN – Signal Generator ............................................................281

SIGGENSWEEP – Signal Generator Sweep .............................................281

SIGTOUT – Signal Generator Time Out .................................................281

SLVL – Speech Level Control ...........................................................282

SMTPSRV – SMTP Mail Server Address .................................................282

SNMPMNGRIP – SNMP Manager Host IP Address .......................................282

SNMPMNGRPORT – SNMP Manager Notification Port ...................................282

SNMPREADCOMM – SNMP Read Community String ....................................282

SNMPWRITECOMM – SNMP Write Community String ...................................282

SPEEDDIAL – Speed Dial a Number ....................................................283

STRING – String Execution.............................................................283

SYSCHECKS – System Checks ........................................................283

SYSRESULT – System Check Result ....................................................284

TAMODE – Telco Adapt Mode ..........................................................285

TELCOLVLCTRL – Telco RX Level Control Enable / Disable ...............................285

TELOVER – Telco Current Overload .....................................................285

TE – Telco Enable .....................................................................285

TIMELOCALE – Time Locale Settings ...................................................285

TOUT – Time Out Select ...............................................................286

TRANSCANCEL – Cancels a Transferred Call............................................298

TRANSCOMPLETE – Completes a Transferred Call ......................................298

TRANSSTART – Initiate an Attended or Unattended Call Transfer ..........................298

UID – Unit ID ..........................................................................286

VER - Version .........................................................................286

VE – VoIP Enable......................................................................298

235

XAA – Auto Answer Enable/Disable .....................................................286

XAAMB – Adaptive Ambient Mode ......................................................286

XAARINGS – Number of Rings to Auto Answer On .......................................287

XACONN – Audible Connect / Disconnect Indication .....................................287

XACONNLVL – Audible Connect / Disconnect Level ......................................287

XAMBLVL – Ambient Level Adjust.......................................................287

XCALLDUR – Call Duration.............................................................288

XCALLERID – Reports Caller ID Information .............................................288

XCGROUP – Compressor Group .......................................................288

XCHAIRO – Chairman Override Mode...................................................288

XCOMPRESS – Compressor Adjust ....................................................289

XCOMPSEL – Compressor Enable......................................................289

XDECAY – Decay Adjust ...............................................................289

XDELAY – Audio Delay.................................................................289

XDELAYSEL – Audio Delay Enable .....................................................290

XDIAL – DTMF Dialing .................................................................290

XDTMFLVL – DTMF Tone Level .........................................................290

XDTONELVL – Dial Tone Level..........................................................291

XGHOLD – Gate Hold Time Adjust ......................................................291

XGMODE – Gating Mode ..............................................................291

XGOVER – Gating Override ............................................................291

XGRATIO – Gate Ratio Adjust ..........................................................291

XGRPSEL – Gating Group Select .......................................................292

XHOOKD – Hook Flash Duration........................................................292

XHOOK – Hook Flash..................................................................292

XLOCALNUM – Local Number .........................................................292

XOFFA – Off Attenuation Mode .........................................................293

XPBDIAL – Dial a PB Entry by Name ....................................................293

XREDIAL – Dial the last number again ..................................................293

XRINGEREN – Audible Ring Enable ....................................................293

XRINGERLVL – Audible Ring Level .....................................................294

XRINGERSEL – Audible Ring Melody Selection ..........................................294

XRINGERTEST – Audible Ring Melody Test .............................................294

XRING – Ring Indication ...............................................................293

XSLVL – Speech Level Control..........................................................294

XSPEEDDIAL – Speed Dialing..........................................................294

XTE – Telco Enable ....................................................................295

236

SERIAL COMMANDS

Serial commands are shown in bold, followed by the command form and argument details.

AA – Auto Answer Enable / Disable

This command selects/reports the setting of auto answer.

Command Form: DEVICE AA <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

AAMB – Adaptive Ambient Mode

This command selects/reports the setting of adaptive ambient.

Command Form: DEVICE AAMB <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 3 (M) - Value Unsigned Integer 2 0 = Off

1 = On 2 = toggle (Null to query in text)

AARINGS – Number of Rings to Auto Answer On

This command selects/reports the setting of the number of rings to auto answer.

Command Form: DEVICE AARINGS <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Unsigned Integer 2 2 - 4

(Null to query in text)

ACONN – Audible Connect / Disconnect Indication

This command selects/reports the status of the audible connect / disconnect indication.

Command Form: DEVICE ACONN <Channel> [Value].

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

237

ACONNLVL – Audible Connect / Disconnect Level

This command selects/reports the audible connect / disconnect indicator’s level.

Command Form: DEVICE ACONNLVL <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Signed Float 2 -12.00 – 12.00

(Null to query in text)

AD – Auto Disconnect Enable / Disable

This command selects/reports the setting of auto disconnect.

Command Form: DEVICE AD <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Unsigned Integer 2 0 = Off

1 = Loop Drop 2 = Call Progress 3 = Loop Drop + Call Progress (Null to query in text)

ADCLIP – Audio Clipping

This command reports the channels that are currently clipping their audio signals. This command is read only. This command is implemented only for inputs.

Command Form: DEVICE ADCLIP [Values]

Argument Type Size Values

Value Bit Map of

Inputs

Bit Map of Outputs

Bit Map of Processors

Bit Map of Faders

Bit Map of Telco 1 XXXX XXXX

2 XXXX XXXX XXXX XXXX

|……………………| Input 1 (lsb) to 12 (msb) |…….| Reserved (Null to query in text)

2 XXXX XXXX XXXX XXXX

|………………………| Output 1 (lsb) to 13 (msb) |….| Reserved

2 XXXX XXXX XXXX XXXX

|……………| Processor A (lsb) to H (msb) |--------------| Reserved

1 XXXX XXXX

|------| Faders 1 (lsb) to 4 (msb) |-------| Reserved

| Telco RX | Telco TX |-----------| Reserved

238

ADPRESENT – Audio Presence

This command displays the channels that currently have valid audio signals present. This command is read only.

Command Form: DEVICE ADPRESENT [Values]

Argument Type Size Values

Value Bit Map of

Inputs

Bit Map of Outputs

Bit Map of Processors

Bit Map of Faders

Bit Map of Telco 1 XXXX XXXX

2 XXXX XXXX XXXX XXXX

|…………………| Input 1 (lsb) to 12 (msb) |…….| Reserved (Null to query in text)

2 XXXX XXXX XXXX XXXX

|……………………| Output 1 (lsb) to 13 (msb) |….| Reserved

2 XXXX XXXX XXXX XXXX

|……………| Processor A (lsb) to H (msb) |--------------| Reserved

1 XXXX XXXX

|------| Faders 1 (lsb) to 4 (msb) |-------| Reserved

| Telco RX | Telco TX |-----------| Reserved

AEC – Acoustic Echo Cancellation Enable / Disable

This command selects/reports the setting of Acoustic Echo Canceller.

Command Form: DEVICE AEC <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 3 (M) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

AGC – Automatic Gain Control

This command selects/reports the setting of automatic gain control.

Command Form: DEVICE AGC <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 1, 3, 7 (I, M, L) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

239

AGCSET – Automatic Gain Control Adjust

This command selects/reports the settings of the Automatic Gain Control.

Command Form: DEVICE AGCSET <Channel> <Group> [Threshold Target Attack Gain]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 1, 3, 7 (I, M, L) - Threshold Signed Integer 1 -50 – 0

(Null to query in text) Target Signed Integer 1 -30 – 20 dB Response

Time Gain Unsigned Float 2 0.00 – 18.00 dB

Unsigned Float 2 0.10 – 10.00

AMBLVL – Ambient Level Adjust

This command selects/reports the ambient level.

Command Form: DEVICE AMBLVL <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 3 (M) - Value Signed Float 2 -80.00 – 0.00

(Null to query in text)

AMXDUET – Use AMX Duet Discovery

This command sets and reports the status of AMX Duet Discovery.

Command Form: DEVICE AMXDUET [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 0 = Off

1 = On 2 = toggle (Null to query in text)

AUDIOMASTER – Expansion Bus Audio Master Mode

This command reports the mode of the unit for control of the expansion bus audio.

Command Form: DEVICE AUDIOMASTER [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 1 = Master

2 = Slave (Null to query in text)

AV – Adaptive Volume

This command enables/disables adaptive volume tracking on a power amplifier channel.

Command Form: DEVICE AV <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 23 (J) - Value Signed Float 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

240

AVG – Adaptive Volume Gain

This command sets the maximum gain setting that the algorithm will not exceed.

Command Form:

Argument Type Size Values Units

Channel Channel 1 See GroupsAndChannels - Group Group 1 23 (J) - Value Signed Short 2 0.00 to +18.00

(Null to query in text)

AVR – Adaptive Volume Reference

This command selects/reports the microphone or expansion bus reference channel to be used for adaptive volume tracking on a power amplifier channel.

Command Form: DEVICE AVR [CHANNEL] [GROUP]

Argument Type Size Values Units

Channel Channel 1 (M) 1-8

(E) 1-18 (Null to query in text)

Group Group 1 3, 6 (M or E) -

AVRT – Adaptive Volume Ratio

This command sets the ratio at which gain will be automatically applied based upon the ambient level in the reference microphone. Example: A 1:1 setting would apply 1 dB of gain for every 1dB rise in ambient level of the reference microphone up to the Max Gain setting.

Command Form: DEVICE AVRT <Channel><Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See GroupAndChannels - Group Group 1 23 (J) - Value Unsigned Short 2 0 = 2:1

1 = 1:1 2 = 1:2 (Null to query in text)

Ratio

AVT – Adaptive Volume Threshold

This command sets the level at which the adaptive volume algorithm will be activated. This value is referenced to the noise floor of the channel and the target above ambient for the adaptive volume to reach.

Command Form: Device AVT <Channel><Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See GroupAndChannels - Group Group 1 23 (J) - Value Signed Short 2 -80.00 to 0.00

(Null to query in text)

BAUD – Baud Rate

This command selects/reports the baud rate of the serial port.

Command Form: DEVICE BAUD [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 9600, 19200, 38400, 57600, 115200

(Null to query in text)

241

BFBINFO – Beamforming Array Beam Information

This command reports the given Beamforming Array’s current active beams. This command is read only.

Command Form: DEVICE BFBINFO [Value]

Argument Type Size Values Units

Value Integer 4 String with binary representation of the status of the eight

(maximum future #) beams. 0 = Beam Inactive 1 = Beam Active (Null to Query in Text)

BFMODE – Sets/Reports Beamforming Mic Mode

This Sets the Beamforming Mic to Table Top, Wall Mount, Ceiling Mount, or Auto (Let the Beamforming Mic decide).

Command Form: DEVICE BFMODE <Channel> <Group> <Value>

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 29 (V) - Value Integer 2 1 = Auto (Default)

2 = Table Top 3 = Ceiling Mount 4 = Wall Mount (Null to Query in Text)

BFPOS – Beamforming Array Position in Auto Mode

This command reports the given Beam Former Array’s Position if the BFMODE is Auto. This command is read only.

Command Form: DEVICE BFPOS [Value]

Argument Type Size Values Units

Value Integer 4 2 = Table Top

3 = Ceiling Mount 4 = Wall Mount (Null to Query in Text)

242

BFZONE – Manually Disables/Enables Beamforming Mic Zones

For each Mode of a Beamforming Mic manually Enable or Disable each of the Mic Zones.

Command Form: DEVICE BFZONE <Channel> <Group> [Zone 1] [Zone 2] [Zone 3] [Zone 4] [Zone 5] [Zone

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 29 (V) - Zone 1 Unsigned

Character

Zone 2 Unsigned

Character

Zone 3 Unsigned

Character

Zone 4 Unsigned

Character

Zone 5 Unsigned

Character

Zone 6 Unsigned

Character

1 0 = Zone Disabled

1 = Zone Enabled (Null to Query in Text)

1 0 = Zone Disabled

1 = Zone Enabled (Null to Query in Text)

1 0 = Zone Disabled

1 = Zone Enabled (Null to Query in Text)

1 0 = Zone Disabled

1 = Zone Enabled (Null to Query in Text)

1 0 = Zone Disabled

1 = Zone Enabled (Null to Query in Text)

1 0 = Zone Disabled

1 = Zone Enabled (Null to Query in Text)

BFMUTEMACRO – Define Macros that Run When Beamforming Mic Mute Button Is Pressed

Define which macros to run on which ConvergePro board to Mute and Un-Mute groups of Beamforming Mics when the specified Beamforming Mic’s Mute button is pressed. This allows pressing a single button to Mute or Un-Mute multiple Beamformingr Mics. If the Macro numbers are zero (default) then ALL Beam Former Mics in the system will be Muted or Un-Muted.

Command Form: DEVICE BFMUTEMACRO [Type ID] [Device ID][ Mute On Macro] [Mute Off Macro]

Argument Type Size Values Units

Type ID Integer 1 Type ID of board where the Mute On and Mute Off

Macros are defined (Null to Query in text)

Device ID Integer 1 Device ID of board where the Mute On and Mute Off

Macros are defined

Mute On

Integer 1 See 14(C) in Groups and Channels

Macro Mute Off

Integer 1 See 14(C) in Groups and Channels

Macro

BFLED – Beamforming Mic LED Mode

This command sets/reports the mode of the Mute Button LEDs on a Beamforming Mic.

Command Form: DEVICE BFLED [Value]

Argument Type Size Values Units

Value Integer 4 0 = OFF (Always not lit)

1 = Steady Red when Muted – Steady Blue when Un-Muted (Default) 2 = Blinking Red when Muted – Steady Blue when Un-Muted (Null to Query in text)

243

CALLDUR – Call Duration

This command returns current call duration. If no call is active, this command returns 0. At the time of call termination, this command will automatically be sent out to report call duration. This command is read only.

Command Form: DEVICE CALLDUR <Channel> <Duration>

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Reserved 2 0 - Duration String 8 String of format HR:MN:SS -

CALLERID – Reports Caller ID Information

This command reports Caller Identification Information. This command is reportable only. It cannot be queried or set.

Command Form: DEVICE CALLERID <Channel> <Number> <Argument>

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Reserved Unsigned Integer 2 0 - Number String 16 1 – 16 chars - Label String 16 1 – 16 chars -

CGROUP – Compressor Group Select

This command selects/reports the setting of the compressor group.

Command Form: DEVICE CGROUP <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 5 (P) - Value Unsigned Integer 2 0 = none

1 – 4 (Null to query in text)

CHAIRO – Chairman Override Mode

This command selects/reports the setting of chairman override.

Command Form: DEVICE CHAIRO <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 3 (M) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

Com-

pressor

Group

244

CLEAREFFECT – ClearEffect Wide Band Telco Emulation

This command enables / disables or reports the current status of the ClearEffect.

Command Form: DEVICE CLEAREFFECT <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

CLOCK – Clock Set

This command sets or reports the current time.

Command Form: DEVICE CLOCK [Date Month Year Hours Minutes Seconds Day]

Argument Type Size Values Units

Date Unsigned Integer 1 1 – 31 - Month Unsigned Integer 1 1 – 12 - Year Unsigned Integer 2 2000 – 2099

(NULL to Query in Text) Hours Unsigned Integer 1 00 – 23 - Minutes Unsigned Integer 1 00 – 59 - Seconds Unsigned Integer 1 00 – 59 - Day of

Week

Unsigned Integer 1 1 = Sunday

2 = Monday

3 = Tuesday

4 = Wednesday

5 = Thursday

6 = Friday

7 = Saturday

COMPDLY – Compressor Delay

This command sets signal compression delay on a Channel for look ahead compression functionality. Delay from 0-20 msec

Command Form: DEVICE COMPDLY <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 23 (J) - Value Unsigned Integer 2 0-20

(Null to query in text)

msec

COMPDLYEN – Compressor Delay Enable

This command enables signal compression delay on a Channel for look-ahead compression functionality

Command Form: DEVICE COMPDLYEN <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 23 (J) - Value Unsigned Short 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

245

COMPRESS – Compressor Adjust

This command selects/reports the settings of the compressor.

Command Form: DEVICE COMPRESS <Channel> [Threshold Ratio Attack Release Gain]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 5 (P) - Threshold Signed Integer 1 -60 – 20

(Null to query in text) Ratio Unsigned Integer 1 1 – 20 Attack Unsigned Float 2 0.00 – 100.00 Ms Release Unsigned Integer 2 100 – 2000 Ms Gain Unsigned Float 4 0.00 – 20.00 dB

COMPSEL – Compression Select

This command selects/reports the compressor activation.

Command Form: DEVICE COMPSEL <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 5 (P) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

COUNTRY – Country Selection

This command sets / reports the country for telco compliance purposes.

Command Form: DEVICE COUNTRY [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 1 = US / Canada

2 = Europe 3 = Mexico 4 = Australia 5 = South Africa 6 = Japan 7 = Brazil 8 = South Korea 9 = China 10 = Singapore 11 = Taiwan 12 = New Zealand 13 = India 14 = Hong Kong 15 = Malaysia 16 = Argentina (Null to query in text)

CTRLMASTER – Control Master Mode

This command reports the mode of the unit for SNMP control.

Command Form: DEVICE CTRLMASTER [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 1 = Master

2 = Slave (Null to query in text)

246

DECAY – Decay Adjust

This command selects/reports the setting of the decay rate.

Command Form: DEVICE DECAY <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 3 (M) - Value Unsigned Integer 2 1 = Slow

2 = Medium 3 = Fast (Null to query in text)

DEFAULT – Default The Unit

Sets the unit to factory defaults. There is no query for this command.

Command Form: DEVICE DEFAULT

No Arguments

DELAY – Delay Adjust

This command selects/reports the setting of delay time.

Command Form: DEVICE DELAY <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 5 (P) - Value Unsigned Float 2 0.00 – 250.00

(Null to query in text)

DELAYSEL – Delay Select

This command selects/reports the delay activation of an assignable processing channel.

Command Form: DEVICE DELAYSEL <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 5 (P) - Value Unsigned Integer 2 0 = Off

1 = On 2 = Toggle (Null to query in text)

DEVICENAME – Argument Identification Label

This selects/reports the Device Argument identification label of the specific channel.

COMMAND FORM: DEVICE DEVICENAME <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 1, 2, 3, 7

(I, O, M, L) Reserved Unsigned Integer 2 0 Label String 12 1 – 12 characters

CLEAR = clear the label

(Null to query in text)

247

DEVICESUBTYPE – Sets the Subtype of a Connected Device

This command enables/disables or reports the current type of device connected to an input or output.

Command Form: DEVICE DEVICESUBTYPE <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 1, 2, 3, 7 (I, O, M, L) - Value Unsigned Integer 2 (NULL to query in text) -

DEVICETYPE – Sets the Type of a Connected Device

This command enables / disables or reports the current type of device connected to an input or output.

Command Form: DEVICE DEVICETYPE <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 1, 2, 3, 7 (I, O, M, L) - Value Unsigned Integer 2 (NULL to query in text) -

DFLTM – Default Meter

This command selects/reports the setting of the default meter on the front panel.

Command Form: DEVICE DFLTM [Channel Group Position]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels

(Null to query in text) Group Group 1 1, 2, 3, 7, 16, 17 (I, O, M, L, T, R) - Position Meter Type 2 1 – 4, as applicable for group

See Meter Type Definitions

DIAG – Diagnostic Commands

This command is used to return status and diagnostic information. It is intended to be used as a text command only. This is a query only command.

Command Form: DEVICE DIAG <Channel> <Group> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 23 (J) - Value Unsigned

Short

Information String 80 Diagnostic String

2 0 = List of current commands

(J) Power Amp 1 = Fan/Temp 2 = Noise Gate 3 = Feedback Nodes

(ALWAYS NULL IN TEXT)

DIAL – DTMF Dialing

This command dials a DTMF sequence or reports back the last sequence dialed.

Command Form: DEVICE DIAL <Channel> [Number]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Reserved 2 0 - Number String 40 1 – 40 Chars of ‘0’ – ‘9’, ‘*’, ‘#’, ‘,’

(Null to query last number dialed in text)

248

DID – Device ID

This command reports the device id. This command is read only except through the front panel.

Command Form: DEVICE DID [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 See Type And Device IDs

(Null sent in text, Value returned)

DTMFLVL – DTMF Tone Level

This command selects/reports the DTMF tone level.

Command Form: DEVICE DTMFLVL <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Signed Float 2 -12.00 – 12.00

(Null to query in text)

DTONELVL – Dial Tone Level

This command selects/reports the audible dial tone level.

Command Form: DEVICE DTONELVL <Channel> [Value]

Argument Type Size Values Units

Channel Channel 1 See Groups and Channels - Group Group 1 17 (R) - Value Signed Float 2 -12.00 – 12.00

(Null to query in text)

DUPDATE – Download Update

This command reports the status of download updates.

Command Form: DEVICE DUPDATE [Channel Group Status Percent Done Message]

Argument Type Size Values Units

Channel Unsigned Integer 1 - Group Unsigned Integer 1 - Status Unsigned Integer 1 (Null to query in text) - Percent Done Unsigned Integer 1 - Message Char 60 -

DVER – Command Dictionary Version

This command reports the version of the command dictionary being used by the unit. This command is read only.

Command Form: DEVICE DVER [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 (Sent with a Null in text) -

ENETADDR – Ethernet Port IP Address

This command selects/reports the IP address of the Ethernet port on the unit.

Command Form: DEVICE ENETADDR [Value]

Argument Type Size Values Units

Value IP Address 4 (Null to query in text) -

249

ENETDHCP – Ethernet DHCP Selection

This command selects/reports the use of DHCP of the Ethernet port on the unit.

Command Form: DEVICE ENETDHCP [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 0 = Off

1 = On 2 = Toggle (Null to query in text)

ENETDNS – Ethernet DNS Selection

This command selects/reports the use of DNS of the Ethernet port on the unit.

Command Form: DEVICE ENETDNS [Value]

Argument Type Size Values Units

Value Unsigned Integer 4 0 = Off

1 = On 2 = Toggle (Null to query in text)

ENETDNSA – Ethernet DNS Server Address

This command selects/reports the DNS server IP address of the Ethernet port on the unit.

Command Form: DEVICE ENETDNSA [Value]

Argument Type Size Values Units

Value IP Address 4 (Null to query in text) -

ENETDNSA2 – Ethernet DNS Server Address 2

This command selects/reports the alternate DNS server IP address of the Ethernet port on the unit.

Command Form: DEVICE ENETDNSA2 [Value]

Argument Type Size Values Units

Value IP Address 4 (Null to query in text) -

ENETDOMAIN – Ethernet Domain Argument

This command selects/reports the Domain Argument of the Ethernet port on the unit.

Command Form: DEVICE ENETDOMAIN [Value]

Argument Type Size Values Units

Value String 64 (Null to query in text) -

ENETGATE – Ethernet Default Gateway Address

This command selects/reports the default gateway of the Ethernet port on the unit.

Command Form: DEVICE ENETGATE [Value]

Argument Type Size Values Units

Value IP Address 4 (Null to query in text) -

ENETSUBN – Ethernet Subnet Mask

This command selects/reports the Subnet mask of the Ethernet port on the unit.

Command Form: DEVICE ENETSUBN [Value]

Argument Type Size Values Units

Value IP Address 4 (Null to query in text) -

250

ENETVLAN – Enable VLAN Tagging

This command enables/disables VLAN tagging. Valid on VH20 ONLY. Change requires reboot to become effective.

Command Form: DEVICE ENETVLAN [Value]

Argument Type Size Values Units

Value Unsigned

Integer

4 0 = VLAN Tagging Off

1 = VLAN Tagging On

2 = Toggle

(Null to query in text)

ENETVLANID – VLAN ID

This command set/reports VLAN Tag ID for all Ethernet packets (including SIP). Valid on VH20 ONLY. Change requires reboot to become effective.

Command Form: DEVICE ENETVLANID [Value]

Argument Type Size Values Units

Value Unsigned

Integer

4 1 – 4094

(Null to query in text)

ENETVLANPRI – VLAN Priority

This command sets/reports the VLAN Tagging Priority for all IP packets. Valid on VH20 ONLY. Change requires reboot to become effective.

Command Form: DEVICE ENETVLANPRI [Value]

Argument Type Size Values Units

Value Unsigned

Integer

4 0 – 7

(Null to query in text)

EREF – Expansion Bus Reference

This command selects an output or reports which output is the expansion bus reference.

Command Form: DEVICE EREF <Channel> [Value Channel Value Group]

Argument Type Size Values Units

Channel Channel 1 See Reference Channels in Groups and Channels - Group Group 1 8 (A, E) - Value Channel 1 0 = none

See 2, 20 (O, B) in Groups and Channels

(Null to query in text)

Value Group 1 0 for none or 2, 20 (N for none or O, B)

EVENT – Run Scheduled Event

This command manually runs a scheduled event on a unit. There is no query associated with this command.

Command Form: DEVICE EVENT <Channel> <Group>

Argument Type Size Values Units

Channel Channel 1 1 - 10 - Group Group 1 21 (Q) - Reserved Unsigned Short 2 0 -

251

+ 55 hidden pages