ClearOne INTERACT Command Guide

INTERACT AT/PRO SERIAL COMMAND GUIDE

Table of Contents

Preface 1
Type and Device IDs 1
Conventions 2

General Text Command Form Description 2

Command Support Table 3

AA – Auto Answer Enable/ Disable 7
AAMB – AdaptiveAmbient Mode 7
AARINGS – Number of Rings to Auto Answer On 7
ACONN – Audible Connect / DisconnectIndication 7
AD – Auto Disconnect Enable/ Disable 9
AEC – Acoustic Echo Canceller Enable/ Disable 9
AECMODE – AEC Stereo / Mono Mode 9
AECREF – Acoustic Echo Cancellation Reference 9
AECREF2 – Acoustic Echo Cancellation Reference 11
AGC – Automatic Gain Control 11
AMBLVL – Ambient Level Adjust 11
BAUD – Baud Rate 11
CALLDUR– Call Duration 12
CAMBAUD – Camera Control Baud Rate 12
CAMCTRLMODE – Camera Control Port Mode 12
CAMFLOW – Camera Control Flow Control 12
CAMMOVE – Move the Camera 13
CAMPOSITION – Camera Position 13
CAMPRESET – Camera Preset 13
CAMPRESETSET – Camera Preset Setup 14
CAMPRESETSET2 – Camera Preset Setup 2 14
CAMSWITCHLAG – Camera Switch Time Lag 14
CAMTRACK – Camera Track 15
CAMZOOM – Camera Zoom 15
CHAIRO – Chairman OverrideMode 15
CLEAREFFECT – Clear Effect Wide Band Telco Emulation 15
CLOCK – Clock Set 16
COMPRESS – Compressor 16
COMPSEL – Compressor Select 17
COMVER – COM Version 17
CONTROLMODE – Table Top Controller Control Mode 17
COUNTRY – Country Selection 18
CPRESET – Configuration Preset 18
DECAY – Decay Rate 18
DEFAULT – Default the Unit 18

5

DEVICE – DeviceIdentification Label 19
DEVICETYPE – Sets the Type of Device connected to an Input or Output 19
DIAL – DTMF Dialing 19
DID – Device ID 19
DSPVER – DSPVersion 21
DSPVEREX – 8i DSP Version 21
DTMFLVL – DTMFTone Level 21
DUPDATE – UpdateNotification when downloading 21
DVER – Command Dictionary Version 23
ENETADDR – Ethernet port IP Address 23
ENETDHCP – Ethernet port Dynamic Host Configuration Protocoladdress
assignment 23
ENETDNS – Ethernet DNS Selection 23
ENETDNSA – Ethernet DNS Server Address 24
ENETGATE – Ethernet default Gateway address 24
ENETSUBN – Ethernet subnet mask 24
EQ – Equalization 24
EQSEL – Equalization Enable 25
ERROR – Error Notification 25
FILSEL – Filter Selection 25
FILTER – Filter Parameters 26
FLOW – Flow Control 26
FMP – First Mic Priority 27
FPGAVER – FPGA Version 27
FPGAVEREX – FPGA Version 27
FREQTABLE – Frequency Table 27
GAIN – Gain Adjustment 28
GATE – Gate Status 28
GHOLD – Gate Hold Time 28
GMODE – Gating Mode 29
GMUTE – Global Mute 29
GRATIO – Gate Ratio 29
GREPORT – Gate Report 30
HCONF – Headset Configuration 30
HOOK – Hook Flash 30
HOOKD – Hook Flash Duration 31
LABEL – Label 31
LOCALNUM – Local Number 31
LOGMASK – Event log mask 32
LVL – Level 32
LVLREPORT – LevelReport 32
LVLREPORTEN – LevelReport Enable 33

MANUFACTURER – Manufacturer Identification Label 33
MICCAMPRESET – Mic Camera Preset 33
MLINE – Mic/Line 34
MMAX – Maximum Number of Microphones 34
MTRX – Matrix Routing 35
MTRXCLEAR – Matrix Clear 35
MTRXLVL – Matrix Level 35
MUTE – Mute 36
NCD – Noise Cancellation Depth 36
NCSEL – Noise Cancellation Select 36
NLP – Non-Linear Processing 37
NOM – Number of Open Microphones 37
OFFA – Off Attenuation 37
PAA – PA Adaptive 38
PBDIAL – Dial a PB Entry by Name 38
PHONEBOOKADD – Adds an Entry to the Phonebook 38
PHONEBOOKCNT – Queries the Number of Entries in the Phonebook 39
PHONEBOOKDEL – Deletes an Entry to the Phonebook 39
PHONEBOOKREAD – Queries an Entry in the Phonebook By Index 39
PODUPDATE – POD/BOB Status Update 40
PODVER – POD Version 40
PP – Phantom Power 40
PTTTHRESHOLD – Push to Talk Threshold 41
PUSHTOTALK – Push To Talk Mode 41
RADIOEN – Radio Enable 41
RADIOSCAN – Radio Scan 41
RADIOSCANRES – Radio Scan Results 42
RADIOSTATEN – Radio Statistics Enable 42
RADIOSTATS – Radio Statistics 42
RAMP – Ramp Gain Adjustment 43
REDIAL – Dial the last number again 43
REFSET – ReferenceSet 43
RESET – Reset 43
RESETUSB – ResetUSB 44
RFVER – RF Version 44
RING – Ring Indication 44
RINGEREN – Ringer Enable 44
RINGERIGN – Ringer Ignore 45
RINGERLVL– AudibleRing Level 45
RINGERSEL – Audible Ring Melody Selection 45
RINGERTEST – Audible Ring Melody Test 45
RXBOOST – Receive Boost 46

RXBSTEN – Receive Boost Enable 46
SILENCEPRST – Silence Camera Preset 47
SPEEDDIAL – Speed Dialing 47
SPLEVEL – Speech LiftLevel 47
SPLIFT – Speech Lift Mode 48
STEREOMIX – Sets the Input to be a Stereo Mix 48
SYSCHECKS – System Checks 48
SYSRESULT – System Check Result 49
TE – Telco Enable 50
TELCOLVLCTRL – Telco RX Level Control Enable/ Disable 50
TELSET – Telephone HeadsetSet 50
TIMELOCALE – Time Locale Settings 51
TLEC – Telco Line Echo Cancellation 51
TM – Telco Mode (Telephone vs Headset) 51
TNLP – Telco Non-Linear Processing 52
UID – Unit ID 52
VER – Version 52
VEREX – Firmware Version 52
VOLBUT – Volume Button 53
VOLUME – Volume Adjustment 53
ZDIAL – DTMF Dialing USB 53
ZRING – Ring Indication USB 54
ZTE – Telco Enable USB 54
Error Messages 54

Designations 55

Group and Channels 55
Interact AT Meter TypeDefinitions 56
Interact PRO Meter TypeDefinitions 56

PREFACE

IINTERACT® Serial Command Guide CLEARONE® PART NO. 801-154-000 December 1, 2011 (REV.1.4)

© 2011 ClearOne - All rights reserved. No part of this document may be reproduced in any form or by any means without written
permission from ClearOne. Printed in the United States of America. ClearOne reserves specific privileges. Information in this document is
subject to change without notice.

Telephone: [phone]

Fax: [phone]

Email: [e-mail]

Web Site: www.clearone.com

TYPE AND DEVICE IDS

The Type ID and Device ID for current supported boxes on the expansion bus have the following definitions:

Type ID Unit Type Device ID Range

0x13 (J) INTERACT AT 0x00

0x14 (K) INTERACT Pro 0x00

Page 1 of 56

CONVENTIONS

This definition uses the following typographic conventions used in this document:

Convention Description

<X> 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

General Text Command Form Description

The commands are outlined in the Command table. The structure of serial commands is as follows:

l # (indicates the start of a command line), Type ID, Device ID, Command, then any additional options in

the order that they appear in the command descriptions on the following pages. Commands can be
either UPPERCASE or lowercase. Return values are always in upper case. In order for a command to
be recognized by the serial port, the command must be terminated by a carriage return.

l If a ‘*’ is placed in the Type ID or Device ID fields, the command is to apply to all units or all devices

respectively.

Indicates the Device Type and Device ID.

l If a command calls for a “NULL” value, leave a blank in the command line (for example “#80 MUTE 2 I”

would return the current mute state of Mic 2 on device 80).

Page 2 of 56

COMMAND SUPPORT TABLE

Command Name Interact AT Interact Pro

AA X X

AAMB X X

AARINGS X X

ACONN X X

AD X X

AEC X X

AECMODE X

AECREF X X

AECREF2 X

AGC X X

AMBLVL X X

BAUD X X

CALLDUR X X

CAMBAUD X

CAMCTRLMODE X

CAMFLOW X

CAMMOVE X

CAMPOSITON X

CAMPRESET X

CAMPRESETSET X

CAMPRESETSET2 X

CAMSWITCHLAG X

CAMTRACK X

CAMZOOM X

CHAIRO X X

CLEAREFFECT X X

CLOCK X X

COMPRESS X

COMPSEL X

COMVER X X

CONTROLMODE X X

COUNTRY X X

CPRESET X

DECAY X X

DEFAULT X X

Page 3 of 56

Command Name Interact AT Interact Pro

DEVICE X X

DEVICETYPE X X

DIAL X X

DID X X

DSPVER X X

DSPVEREX X

DTMFLVL X X

DUPDATE X X

DVER X X

ENETADDR X X

ENETDHCP X X

ENETDNS X X

ENETDNSA X X

ENETGATE X X

ENETSUBN X X

EQ X X

EQSEL X X

ERROR X X

FILSEL X X

FILTER X X

FLOW X X

FMP X

FPGAVER X X

FPGAVEREX X

FREQTABLE X X

GAIN X X

GATE X X

GHOLD X X

GMODE X X

GMUTE X X

GRATIO X X

GREPORT X X

HCONF X X

HOOK X X

HOOKD X X

LABEL X X

LOCALNUM X X

Page 4 of 56

Command Name Interact AT Interact Pro

LOGMASK X X

LVL X X

LVLREPORT X X

LVLREPORTEN X X

MANUFACTURER X X

MICCAMPRESET X

MLINE X X

MMAX X

MTRX X X

MTRXCLEAR X

MTRXLVL X

MUTE X X

NCD X X

NCSEL X X

NLP X X

NOM X

OFFA X X

PAA X X

PBDIAL X X

PHONEBOOKADD X X

PHONEBOOKCNT X X

PHONEBOOKDEL X X

PHONEBOOKREAD X X

PODUPDATE X X

PODVER X X

PP X X

PTTTHRESHOLD X X

PUSHTOTALK X X

RADIOEN X X

RADIOSCAN X X

RADIOSCANRES X X

RADIOSTATEN X X

RADIOSTATS X X

RAMP X X

REDIAL X X

REFSET X

RESET X X

Page 5 of 56

Command Name Interact AT Interact Pro

RESETUSB X X

RFVER X X

RING X X

RINGEREN X X

RINGERIGN X

RINGERLVL X X

RINGERSEL X X

RINGERTEST X X

RXBOOST X X

RXBSTEN X X

SILENCEPRST X

SPEEDDIAL X X

SPLEVEL X

SPLIFT X

STEREOMIX X

SYSCHECKS X X

SYSRESULTS X X

TE X X

TELCOLVLCTRL X X

TELSET X X

TIMELOCALE X X

TLEC X X

TM X

TNLP X X

UID X X

VER X X

VEREX X

VOLBUT X

VOLUME X X

ZDIAL X X

ZRING X X

ZTE X X

Page 6 of 56

AA – Auto Answer Enable/ Disable

This command selects/reports the setting of auto answer.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 17 (R)

0 = Off

Value Unsigned Integer 2

TEXT FORM DETAILS

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

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

AAMB – Adaptive Ambient Mode

This command selects/reports the setting of the Adaptive Ambient.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 3 (M)

0 = Off

Value Unsigned Integer 2

TEXT FORM DETAILS

COMMAND FORM:DEVICE AAMB <Channel> [Value]

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.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 17 (R)

Value Unsigned Integer 2

TEXT FORM DETAILS

COMMAND FORM:DEVICE AARINGS <Channel> [Value]

2 or 4
(Null to query in text)

ACONN – Audible Connect / Disconnect Indication

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

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 17 (R)

0 = Off

Value Unsigned Integer 2

1 = On
2 = Toggle

Page 7 of 56

TEXT FORM DETAILS

COMMAND FORM:DEVICE ACONN <Channel> [Value]

(Null to query in text)

Page 8 of 56

AD – Auto Disconnect Enable/ Disable

This command selects/reports the setting of auto disconnect.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 17 (R)

0 = Off
1 = Loop Drop

Value Unsigned Integer 2

TEXT FORM DETAILS

COMMAND FORM:DEVICE AD <Channel> [Value]

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

AEC – Acoustic Echo Canceller Enable/ Disable

This command selects/reports the setting of Acoustic Echo Canceller for the specified Microphone channel.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 3 (M)

0 = Off

Value Unsigned Integer 2

TEXT FORM DETAILS

COMMAND FORM:DEVICE AEC <Channel> [Value]

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

AECMODE – AEC Stereo / Mono Mode

This command selects/reports the control mode for the AEC

ARGUMENT DETAILS

Name Type Size Values

0 = Mono

Value Unsigned Integer 4

TEXT FORM DETAILS

COMMAND FORM:DEVICE AECMODE [Value]

1 = Stereo
(Null to query in text)

AECREF – Acoustic Echo Cancellation Reference

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

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 2

Group Group 2 2, 20 (O, B)

TEXT FORM DETAILS

Page 9 of 56

See GroupAndChannels
(Null to query in text)

COMMAND FORM:DEVICE AECREF [Channel Group]

Page 10 of 56

AECREF2 – Acoustic Echo Cancellation Reference

This command enables / disables or reports the current status of the 2ndAEC reference.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 2

Group Group 2 2, 20 (O, B)

TEXT FORM DETAILS

COMMAND FORM:DEVICE AECREF2 [Channel Group]

See GroupAndChannels
(Null to query in text)

AGC – Automatic Gain Control

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

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 3 (M)

0 = Off

Value Unsigned Integer 2

TEXT FORM DETAILS

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

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

AMBLVL – Ambient Level Adjust

This command selects / reports the current Ambient Level.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See Groups and Channels

Group Group 1 3 (M)

Value Signed Float 2

TEXT FORM DETAILS

COMMAND FORM:DEVICE AMBLVL <Channel> [Value]

BAUD – Baud Rate

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

ARGUMENT DETAILS

Name Type Size Values

Value Unsigned Integer 4

TEXT FORM DETAILS

COMMAND FORM:DEVICE BAUD [Value]

-80.00 - 0.00
(Null to query in text

38400, 57600,115200
(Null to query in text)

Page 11 of 56

CALLDUR – Call Duration

This command indicates how long a call has lasted. If no call is in session, this will report 0. At the time of call
termination, this command will automatically be sent out reporting the duration.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 17 (R)

Reserved 2 0

Duration String 8 String of format HR:MN:SS

TEXT FORM DETAILS

COMMAND FORM:DEVICE CALLDUR <Channel> <Duration>

CAMBAUD – Camera Control Baud Rate

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

ARGUMENT DETAILS

Name Type Size Values

Value Unsigned Integer 4

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMBAUD [Value]

4800, 9600, 14400, 19200
(Null to query in text)

CAMCTRLMODE – Camera Control Port Mode

This command sets / reports the camera control port mode.

ARGUMENT DETAILS

Name Type Size Values

0 = Sony

Value Unsigned Integer 4

1 = Canon
(Null to Query in Text)

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMCTRLMODE [Value]

CAMFLOW – Camera Control Flow Control

This command selects/reports the flow control of the camera control serial port on the unit. Hardware flow
control is implemented using DTR and DSR.

ARGUMENT DETAILS

Name Type Size Values

0 = Off

Value Unsigned Integer 4

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMFLOW [Value]

Page 12 of 56

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

CAMMOVE – Move the Camera

This command sends commands to move the camera on the camera control port. There is no query for this
command.

ARGUMENT DETAILS

Name Type Size Values

Channel Channel 1 See GroupAndChannels

Group Group 1 19 (V)

0 = Stop
1 = Pan Right
2 = Pan Left

Value Unsigned Integer 2

TEXT FORM DETAILS

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

3 = Tilt Up
4 = Tilt Down
5 = Zoom In
6 = Zoom Out

CAMPOSITION – Camera Position

This command sets or reports the current position of the camera on the camera control port.

ARGUMENT DETAILS

Name Type Size Values Units

Channel Channel 1 See GroupAndChannels

Group Group 1 19 (V)

If Sony, -100 to 100.

Pan Angle Signed Float 2

Tilt Angle Signed Float 4

If Canon, -100 to 100.
(NULL to Query in Text)

If Sony, -25 to 25.
If Canon, -30 to 30.

Degrees

Degrees

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMPOSITON <Channel Group> [Pan Tilt]

CAMPRESET – Camera Preset

Executes a camera preset. There is no query for this command.

ARGUMENT DETAILS

Name Type Size Values

Value Unsigned Integer 4 1 – 10

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMPRESET [Value]

Page 13 of 56

CAMPRESETSET – Camera Preset Setup

This command sets the current position of a camera as a camera preset. There is no query for this command.

ARGUMENT DETAILS

Name Type Size Values

Preset Unsigned Integer 2 1 – 10

Channel Channel 1 See GroupAndChannels

Group Group 1 19 (V)

Label String 16

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMPRESETSET <Preset Channel Group Label>

CAMPRESETSET2 – Camera Preset Setup 2

This command sets or reports the current camera preset.

ARGUMENT DETAILS

Name Type Size Values Units

Preset Unsigned Integer 2 1 – 10

Channel Channel 1 See GroupAndChannels

Group Group 1 19 (V)

If Sony, -100 to 100.

Pan Angle Signed Float 2

Tilt Angle Signed Float 2

Zoom Angle Signed Float 4

Label String 16

TEXT FORM DETAILS

COMMAND FORM: DEVICE CAMPRESETSET2 <Preset>[Channel Group Pan Tilt Zoom Label]

If Canon, -100 to 100.
(NULL to Query in Text)

If Sony, -25 to 25.
If Canon, -30 to 90.

If Sony, 6.6 to 65.
If Canon, 3 to 47.5.

Degrees

Degrees

Degrees

CAMSWITCHLAG – Camera Switch Time Lag

This command set the switch time lag for voice tracking.

ARGUMENT DETAILS

Name Type Size Values

Value Unsigned Float 4 0.00 – 5.00 s

TEXT FORM DETAILS

COMMAND FORM:DEVICE CAMSWITCHLAG [Value]

Page 14 of 56