INTERACT AT/PRO SERIAL COMMAND GUIDE
Table of Contents Preface Type and Device IDs Conventions General Text Command Form Description Command Support Table AA – Auto Answer Enable/ Disable AAMB – Adaptive Ambient Mode AARINGS – Number of Rings to Auto Answer On ACONN – Audible Connect / Disconnect Indication AD – Auto Disconnect Enable/ Disable AEC – Acoustic Echo Canceller Enable/ Disable AECMODE – AEC Stereo / Mono Mode AECREF – Acoustic Echo Cancellation Reference AECREF2 – Acoustic Echo Cancellation Reference AGC – Automatic Gain Control A
DEVICE – Device Identification Label DEVICETYPE – Sets the Type of Device connected to an Input or Output DIAL – DTMF Dialing DID – Device ID DSPVER – DSP Version DSPVEREX – 8i DSP Version DTMFLVL – DTMF Tone Level DUPDATE – Update Notification when downloading DVER – Command Dictionary Version ENETADDR – Ethernet port IP Address ENETDHCP – Ethernet port Dynamic Host Configuration Protocol address assignment ENETDNS – Ethernet DNS Selection ENETDNSA – Ethernet DNS Server Address ENETGATE – Ethernet default
MANUFACTURER – Manufacturer Identification Label MICCAMPRESET – Mic Camera Preset MLINE – Mic/Line MMAX – Maximum Number of Microphones MTRX – Matrix Routing MTRXCLEAR – Matrix Clear MTRXLVL – Matrix Level MUTE – Mute NCD – Noise Cancellation Depth NCSEL – Noise Cancellation Select NLP – Non-Linear Processing NOM – Number of Open Microphones OFFA – Off Attenuation PAA – PA Adaptive PBDIAL – Dial a PB Entry by Name PHONEBOOKADD – Adds an Entry to the Phonebook PHONEBOOKCNT – Queries the Number of Entries in
RXBSTEN – Receive Boost Enable SILENCEPRST – Silence Camera Preset SPEEDDIAL – Speed Dialing SPLEVEL – Speech Lift Level SPLIFT – Speech Lift Mode STEREOMIX – Sets the Input to be a Stereo Mix SYSCHECKS – System Checks SYSRESULT – System Check Result TE – Telco Enable TELCOLVLCTRL – Telco RX Level Control Enable/ Disable TELSET – Telephone Headset Set TIMELOCALE – Time Locale Settings TLEC – Telco Line Echo Cancellation TM – Telco Mode (Telephone vs Headset) TNLP – Telco Non-Linear Processing UID – Unit ID
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: 1-800-945-7730 Fax: 1-801-977-0087 Email: tech.support@clearone.com Web Site: www.clearone.
CONVENTIONS This definition uses the following typographic conventions used in this document: Convention Description 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 BAUD DEVICE Parameters separated by a comma "," indicate a list of available values. Words in UPPERCASE Bold indicate command text. Indicates the Device Type and Device ID.
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 AECREF2 X 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 D
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 FPGAVER X X FPGAVEREX X 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
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 MMAX X 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 RADIOSTATE
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 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 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) 2 0 = Off 1 = On 2 = Toggle (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE AA [Value] AAMB – Adaptive Ambient Mode This command selects/reports the setting of the Adaptive Ambient.
(Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE ACONN [Value] Page 8 of 56
AD – Auto Disconnect Enable/ Disable This command selects/reports the setting of auto disconnect.
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 2nd AEC reference. ARGUMENT DETAILS Name Type Size Values Channel Channel 2 See GroupAndChannels (Null to query in text) Group Group 2 2, 20 (O, B) TEXT FORM DETAILS COMMAND FORM:DEVICE AECREF2 [Channel Group] AGC – Automatic Gain Control This command selects/reports the setting of automatic gain control for the specified channel.
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.
CAMMOVE – Move the Camera This command sends commands to move the camera on the camera control port. There is no query for this command.
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 CAMPRESETSET2 – Camera Preset Setup 2 This command sets or reports the current camera preset.
CAMTRACK – Camera Track This command selects/reports the camera voice tracking mode. ARGUMENT DETAILS Name Value Type Size Values 4 0 = Off 1 = On 2 = Toggle (Null to query in text) Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE CAMTRACK [Value] CAMZOOM – Camera Zoom This command sets or reports the current Zoom of the camera on the camera control port.
CLOCK – Clock Set This command sets or reports the current time.
COMPSEL – Compressor Select This command selects/reports the compressor on/off status. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 5 (P) 2 0 = Off 1 = On 2 = Toggle (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE COMPSEL [Value] COMVER – COM Version This command reports the version of the Interact COM (USB) firmware. This command is read only.
COUNTRY – Country Selection This command sets / reports the country for compliance. ARGUMENT DETAILS Name Value Type Unsigned Integer Size Values 4 1 = US / Canada 2 = Europe 3 = Mexico 4 = Australia / New Zealand 5 = South Africa 6 = Japan 7 = Brazil 8 = South Korea 9 = China 10 = Singapore 11 = Taiwan 12 = Hong Kong 13 = India (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE COUNTRY [Value] CPRESET – Configuration Preset This command runs a configuration preset.
DEVICE – Device Identification Label This selects/reports the manufacturer identification label of the specific channel.
COMMAND FORM:DEVICE DID [Value] Page 20 of 56
DSPVER – DSP Version This command reports the version of the DSP code in the INTERACT Pro and AT unit. This command is read only. ARGUMENT DETAILS Name Type Size Values Value Unsigned Integer 4 0 for Host 1 for Satellite 9 for Telco (Pro only) Value Unsigned Integer 32 (Sent with a Null in text) Value Unsigned Integer 32 TEXT FORM DETAILS COMMAND FORM:DEVICE DSPVER DSPVEREX – 8i DSP Version This command reports the version of the DSP code in the INTERACT Pro 8i unit.
Argument 1 Hexadecimal 2 Group and Channel of the download Group N (15), channels 2 (HTML skin) and 3 (Firmware). Argument 2 Hexadecimal 2 Status and percent done.
DVER – Command Dictionary Version This command reports the version of the command dictionary being used by the unit. This command is read only. ARGUMENT DETAILS Name Type Size Values Value Unsigned Integer 4 (Sent with a Null in text) BINARY FORM DETAILS COMMAND ID:42 Number of ARGUMENTS:1 ARGUMENT FORM: TEXT FORM DETAILS COMMAND FORM:DEVICE DVER [Value] ENETADDR – Ethernet port IP Address This command selects/reports the IP Address of the Ethernet port on the unit.
ENETDNSA – Ethernet DNS Server Address This command selects/reports the DNS’s IP Address of the Ethernet port on the unit. ARGUMENT DETAILS Name Type Size Values Value IP Address 4 (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE ENETDNSA [Value] ENETGATE – Ethernet default Gateway address This command selects/reports the default gateway of the Ethernet port on the unit.
EQSEL – Equalization Enable COMMAND FORM:DEVICE FPGAVER [Value] This command enables / disables or reports the current status of the equalization on the input or output.
FILTER – Filter Parameters This command selects/reports the parameters for a filter on a microphone.
FMP – First Mic Priority This command selects/reports First Mic Priority Mode. ARGUMENT DETAILS Name Value Type Unsigned Short Size Values 2 0 = Off 1 = On 2 = Toggle (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE FMP [Value] FPGAVER – FPGA Version This command reports the version of the FPGA code in the unit. This command is read only.
GAIN – Gain Adjustment This command changes or reports back the gain for a specified channel. ARGUMENT DETAILS Name Type Size Channel Channel 1 See GroupAndChannels Group Group 1 2, 3, 5, 7, 16, 17, 26, 27, 28, 29 (O, M, P, L, T, R, H, N, D, W) Value Signed Float 2 -99.90 – 99.
GMODE – Gating Mode This command selects/reports the status of the gate mode for a microphone. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 3 (M) 2 0 = Auto 1 = On 2 = Off 3 = Override On (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE GMODE [Value] GMUTE – Global Mute This command selects/reports the global mute for the microphones.
GREPORT – Gate Report This command selects/reports the mode of gate status reporting. ARGUMENT DETAILS Name Value Type Unsigned Integer Size Values 4 0 = Off 1 = On 2 = Toggle (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE GREPORT [Value] HCONF – Headset Configuration This command selects/reports the headset configuration for the unit.
HOOKD – Hook Flash Duration This command selects/reports the hook flash duration. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 17 (R) Value Unsigned Integer 2 50 – 1000 ms (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE HOOKD [Value] LABEL – Label This selects/reports the label of the specific channel or the unit.
LOGMASK – Event log mask This command sets or reports the unit event log mask.
LVLREPORTEN – Level Report Enable Enables level reporting for the unit. ARGUMENT DETAILS Name Value Type Size Values 4 0 = Turn off reporting but leave current list 1 = Turn on reporting 2 = Turn off reporting and clear the list (Null to query in text) Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE LVLREPORTEN [Value] MANUFACTURER – Manufacturer Identification Label This selects/reports the manufacturer identification label of the specific channel.
MLINE – Mic/Line This command selects/reports the coarse gain for a microphone. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 3 (M) 2 0 = 0 dB 1 = 7 dB 2 = 14 dB 3 = 21 dB 4 = 28 dB 5 = 35 dB 6 = 42 dB 7 = 49 dB 8 = 56 dB (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE MLINE [Value] MMAX – Maximum Number of Microphones This command sets or reports the maximum number of microphones for gating.
MTRX – Matrix Routing This command selects/reports the matrix routing of an input to an output. ARGUMENT DETAILS Name Type Size Source Channel Channel 1 See GroupAndChannels Source Group Group 1 3, 5, 7, 17, 27, 29 (M, P, L, R, N, W) Destination Channel Channel 1 The all channel is not allowed.
MUTE – Mute This command selects/reports the setting of mute on a specified channel.
NLP – Non-Linear Processing This command selects/reports the non-linear processing for a microphone. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 3 (M) 2 0 = Off 1 = Soft 2 = Medium 3 = Aggressive (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE NLP [Value] NOM – Number of Open Microphones This command selects/reports the setting of number of open microphone level adjust for an output.
PAA – PA Adaptive This command selects/reports the PA adaptive mode for a microphone. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 3 (M) 2 0 = Off 1 = On 2 = Toggle (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE PAA [Value] PBDIAL – Dial a PB Entry by Name This command dials a speed dial number by name. There is no query for this command.
PHONEBOOKCNT – Queries the Number of Entries in the Phonebook This command queries the number of entries in the phonebook. This command is query only!! ARGUMENT DETAILS Name Type Size Values Value Unsigned Integer 4 0 – 20 TEXT FORM DETAILS COMMAND FORM:DEVICE PHONEBOOKCNT [Value] PHONEBOOKDEL – Deletes an Entry to the Phonebook This command deletes an entry in the phonebook. There is no query for this command.
PODUPDATE – POD/BOB Status Update This command reports the status of the POD / BOB’s for the unit.
PTTTHRESHOLD – Push to Talk Threshold This command selects/reports the threshold for push to talk adaption for a Microphone channel. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 3 (M) Value Signed Float 2 -100.00 – 0.00 dB (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE PTTTHRESHOLD [Value] PUSHTOTALK – Push To Talk Mode This command selects/reports the push to talk adaption for a Microphone channel.
RADIOSCANRES – Radio Scan Results This command reports the radio scan results. This command is reportable only. It cannot be queried or set. ARGUMENT DETAILS Name Values Type Size Values 8 1 byte for each of the Radio Channels 0 = Channel Free 1 = Channel Occupied (Null to query in text) Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE RADIOSCANRES [Values] RADIOSTATEN – Radio Statistics Enable This command enables / disables the radio statics reporting.
RAMP – Ramp Gain Adjustment This command starts / stops the gain ramp on a specified channel. There is no query for this command! ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 2, 5, 7 (O, P, L) Rate Signed Integer 1 -50 to +50 dB / s If Rate = 0, the ramp will stop If Rate < 0, the gain will ramp down If Rate > 0, the gain will ramp up Target Signed Integer 1 -65.00 to +20.
RESETUSB – Reset USB This command resets the USB interface on the COM module and causes the USB to re-enumerate. ARGUMENT DETAILS Name Type Size Values Rsvd Unsigned Short 4 - TEXT FORM DETAILS COMMAND FORM:DEVICE RESETUSB [Value] RFVER – RF Version This command reports the version of the microcontroller code for the RF in the USB/Headset Break Out Box. This command is read only.
RINGERIGN – Ringer Ignore This command causes the ring tone to be suppressed and the generation of the RING command until the current incoming call is disconnected. There is no query for this command. ARGUMENT DETAILS Name Type Size Values Channel 1 See GroupAndChannels Group Channel Group 1 3 (R) Reserved - 2 TEXT FORM DETAILS COMMAND FORM:DEVICE RINGERIGN RINGERLVL – Audible Ring Level This command selects/reports the audible ring’s level.
RXBOOST – Receive Boost This command selects/reports the receive boost status. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 17 (R) Value Unsigned Integer 2 0, 3, 6, 9, or 12 dB (Null to query in text) TEXT FORM DETAILS COMMAND FORM:DEVICE RXBOOST RXBSTEN – Receive Boost Enable This command enables/disables the receive boost.
SILENCEPRST – Silence Camera Preset This command associates a camera preset with silence for voice tracking. ARGUMENT DETAILS Name Type Size Values Value Unsigned Integer 4 0 to Clear 1 – 10 (NULL to Query in Text) TEXT FORM DETAILS COMMAND FORM:DEVICE SILENCEPRST [Value] SPEEDDIAL – Speed Dialing This command dials a speed dial number by speed dial number. There is no query for this command.
SPLIFT – Speech Lift Mode This command selects/reports the status of the speech lift mode for a microphone. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 3 (M) 2 0 = Off 1 = On 2 = Toggle (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE SPLIFT [Value] STEREOMIX – Sets the Input to be a Stereo Mix This command enables / disables or reports the stereo mix status of an input.
SYSRESULT – System Check Result This command reports the results of the system check. This command is reportable only. It cannot be queried or set. ARGUMENT DETAILS Name Type Size Values System Check Hexadecimal 2 0 = Box 1 (mics A1-3) 1 = Box 2 (mics B1-3) 2 = Box 3 (mics C1-3) 3 = Speaker 4 = Telephone 5 = Network 6 = USB All other bits reserved. Status Unsigned Integer 2 0 = Fail 1 = Pass For the Break Out Boxes: this message will say if a box is not connected.
TE – Telco Enable This command selects/reports the hook status. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 17 (R) 2 0 = Off 1 = On 2 = Toggle (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE TE [Value] TELCOLVLCTRL – Telco RX Level Control Enable/ Disable This command selects/reports the setting of Telco RX level control.
TIMELOCALE – Time Locale Settings This command sets or reports the time locale settings. ARGUMENT DETAILS Name Type Size Values Daylight Savings Unsigned Integer 4 0 = Do not use Daylight Savings 1 = Use Daylight Savings (NULL to Query in Text) Time Zone Unsigned Integer 4 The number of seconds from UDT.
TNLP – Telco Non-Linear Processing This command selects/reports the status of the Telco line echo suppression. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Group Group 1 17, 27 (R, N) 2 0 = Off 1 = On 2 = Toggle (Null to query in text) Value Unsigned Integer TEXT FORM DETAILS COMMAND FORM:DEVICE TNLP [Value] UID – Unit ID This command reports the unit id. This command is read only.
VOLBUT – Volume Button This command sets or reports the channel assigned to the volume button or command. ARGUMENT DETAILS Name Type Size Values Channel Channel 2 See GroupAndChannels (Null to query in text) Group Group 2 2, 5 (O, P) TEXT FORM DETAILS COMMAND FORM:DEVICE VOLBUT [Channel Group] VOLUME – Volume Adjustment This command changes or reports back the gain for the output channel set as the EC reference. ARGUMENT DETAILS Name Type Size Values Value Signed Float 4 -99.90 – 99.
ZRING – Ring Indication USB This command indicates a ringing line. This command is reportable only. It cannot be queried or set. ARGUMENT DETAILS Name Type Size Values Channel Channel 1 See GroupAndChannels Value Unsigned Integer 2 0 = Ring cycle has stopped 1 = Ring cycle has begun TEXT FORM DETAILS COMMAND FORM:DEVICE ZRING ZTE – Telco Enable USB This command selects/reports the hook status.
DESIGNATIONS The following tables define the relationship between alpha and numeric representations. Text commands use the alpha designation and binary commands use the numeric. In addition, different groups have different allowable channel ranges.
If a channel has a numeric value of 0xff or an alpha value of ‘*’, the command is to be applied to all channels. For example, a group value of 0x3 and a channel value of 0xff would mean that the command is to be applied to all channels of group 3 (Mic inputs).
