AA – Auto Answer Enable/ Disable7
AAMB – AdaptiveAmbient Mode7
AARINGS – Number of Rings to Auto Answer On7
ACONN – Audible Connect / DisconnectIndication7
AD – Auto Disconnect Enable/ Disable9
AEC – Acoustic Echo Canceller Enable/ Disable9
AECMODE – AEC Stereo / Mono Mode9
AECREF – Acoustic Echo Cancellation Reference9
AECREF2 – Acoustic Echo Cancellation Reference11
AGC – Automatic Gain Control11
AMBLVL – Ambient Level Adjust11
BAUD – Baud Rate11
CALLDUR– Call Duration12
CAMBAUD – Camera Control Baud Rate12
CAMCTRLMODE – Camera Control Port Mode12
CAMFLOW – Camera Control Flow Control12
CAMMOVE – Move the Camera13
CAMPOSITION – Camera Position13
CAMPRESET – Camera Preset13
CAMPRESETSET – Camera Preset Setup14
CAMPRESETSET2 – Camera Preset Setup 214
CAMSWITCHLAG – Camera Switch Time Lag14
CAMTRACK – Camera Track15
CAMZOOM – Camera Zoom15
CHAIRO – Chairman OverrideMode15
CLEAREFFECT – Clear Effect Wide Band Telco Emulation15
CLOCK – Clock Set16
COMPRESS – Compressor16
COMPSEL – Compressor Select17
COMVER – COM Version17
CONTROLMODE – Table Top Controller Control Mode17
COUNTRY – Country Selection18
CPRESET – Configuration Preset18
DECAY – Decay Rate18
DEFAULT – Default the Unit18
5
DEVICE – DeviceIdentification Label19
DEVICETYPE – Sets the Type of Device connected to an Input or Output19
DIAL – DTMF Dialing19
DID – Device ID19
DSPVER – DSPVersion21
DSPVEREX – 8i DSP Version21
DTMFLVL – DTMFTone Level21
DUPDATE – UpdateNotification when downloading21
DVER – Command Dictionary Version23
ENETADDR – Ethernet port IP Address23
ENETDHCP – Ethernet port Dynamic Host Configuration Protocoladdress
assignment23
ENETDNS – Ethernet DNS Selection23
ENETDNSA – Ethernet DNS Server Address24
ENETGATE – Ethernet default Gateway address24
ENETSUBN – Ethernet subnet mask24
EQ – Equalization24
EQSEL – Equalization Enable25
ERROR – Error Notification25
FILSEL – Filter Selection25
FILTER – Filter Parameters26
FLOW – Flow Control26
FMP – First Mic Priority27
FPGAVER – FPGA Version27
FPGAVEREX – FPGA Version27
FREQTABLE – Frequency Table27
GAIN – Gain Adjustment28
GATE – Gate Status28
GHOLD – Gate Hold Time28
GMODE – Gating Mode29
GMUTE – Global Mute29
GRATIO – Gate Ratio29
GREPORT – Gate Report30
HCONF – Headset Configuration30
HOOK – Hook Flash30
HOOKD – Hook Flash Duration31
LABEL – Label31
LOCALNUM – Local Number31
LOGMASK – Event log mask32
LVL – Level32
LVLREPORT – LevelReport32
LVLREPORTEN – LevelReport Enable33
MANUFACTURER – Manufacturer Identification Label33
MICCAMPRESET – Mic Camera Preset33
MLINE – Mic/Line34
MMAX – Maximum Number of Microphones34
MTRX – Matrix Routing35
MTRXCLEAR – Matrix Clear35
MTRXLVL – Matrix Level35
MUTE – Mute36
NCD – Noise Cancellation Depth36
NCSEL – Noise Cancellation Select36
NLP – Non-Linear Processing37
NOM – Number of Open Microphones37
OFFA – Off Attenuation37
PAA – PA Adaptive38
PBDIAL – Dial a PB Entry by Name38
PHONEBOOKADD – Adds an Entry to the Phonebook38
PHONEBOOKCNT – Queries the Number of Entries in the Phonebook39
PHONEBOOKDEL – Deletes an Entry to the Phonebook39
PHONEBOOKREAD – Queries an Entry in the Phonebook By Index39
PODUPDATE – POD/BOB Status Update40
PODVER – POD Version40
PP – Phantom Power40
PTTTHRESHOLD – Push to Talk Threshold41
PUSHTOTALK – Push To Talk Mode41
RADIOEN – Radio Enable41
RADIOSCAN – Radio Scan41
RADIOSCANRES – Radio Scan Results42
RADIOSTATEN – Radio Statistics Enable42
RADIOSTATS – Radio Statistics42
RAMP – Ramp Gain Adjustment43
REDIAL – Dial the last number again43
REFSET – ReferenceSet43
RESET – Reset43
RESETUSB – ResetUSB44
RFVER – RF Version44
RING – Ring Indication44
RINGEREN – Ringer Enable44
RINGERIGN – Ringer Ignore45
RINGERLVL– AudibleRing Level45
RINGERSEL – Audible Ring Melody Selection45
RINGERTEST – Audible Ring Melody Test45
RXBOOST – Receive Boost46
RXBSTEN – Receive Boost Enable46
SILENCEPRST – Silence Camera Preset47
SPEEDDIAL – Speed Dialing47
SPLEVEL – Speech LiftLevel47
SPLIFT – Speech Lift Mode48
STEREOMIX – Sets the Input to be a Stereo Mix48
SYSCHECKS – System Checks48
SYSRESULT – System Check Result49
TE – Telco Enable50
TELCOLVLCTRL – Telco RX Level Control Enable/ Disable50
TELSET – Telephone HeadsetSet50
TIMELOCALE – Time Locale Settings51
TLEC – Telco Line Echo Cancellation51
TM – Telco Mode (Telephone vs Headset)51
TNLP – Telco Non-Linear Processing52
UID – Unit ID52
VER – Version52
VEREX – Firmware Version52
VOLBUT – Volume Button53
VOLUME – Volume Adjustment53
ZDIAL – DTMF Dialing USB53
ZRING – Ring Indication USB54
ZTE – Telco Enable USB54
Error Messages54
Designations55
Group and Channels55
Interact AT Meter TypeDefinitions56
Interact PRO Meter TypeDefinitions56
PREFACE
IINTERACT® Serial Command Guide CLEARONE® PART NO. 801-154-000 December 1, 2011 (REV.1.4)
The Type ID and Device ID for current supported boxes on the expansion bus have the following definitions:
Type IDUnit TypeDevice ID Range
0x13 (J)INTERACT AT0x00
0x14 (K)INTERACT Pro0x00
Page 1 of 56
CONVENTIONS
This definition uses the following typographic conventions used in this document:
ConventionDescription
<X>Parameters enclosed in "< >" indicate a mandatory parameter.
[X]Parameters enclosed in "[ ]" indicate an optional parameter.
1-8Parameters separated by a hyphen ("-") indicate a range between the values.
4,7,9Parameters separated by a comma "," indicate a list of available values.
BAUDWords 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 NameInteract AT Interact Pro
AAXX
AAMBXX
AARINGSXX
ACONNXX
ADXX
AECXX
AECMODEX
AECREFXX
AECREF2X
AGCXX
AMBLVLXX
BAUDXX
CALLDURXX
CAMBAUDX
CAMCTRLMODEX
CAMFLOWX
CAMMOVEX
CAMPOSITONX
CAMPRESETX
CAMPRESETSETX
CAMPRESETSET2X
CAMSWITCHLAGX
CAMTRACKX
CAMZOOMX
CHAIROXX
CLEAREFFECTXX
CLOCKXX
COMPRESSX
COMPSELX
COMVERXX
CONTROLMODEXX
COUNTRYXX
CPRESETX
DECAYXX
DEFAULTXX
Page 3 of 56
Command NameInteract AT Interact Pro
DEVICEXX
DEVICETYPEXX
DIALXX
DIDXX
DSPVERXX
DSPVEREXX
DTMFLVLXX
DUPDATEXX
DVERXX
ENETADDRXX
ENETDHCPXX
ENETDNSXX
ENETDNSAXX
ENETGATEXX
ENETSUBNXX
EQXX
EQSELXX
ERRORXX
FILSELXX
FILTERXX
FLOWXX
FMPX
FPGAVERXX
FPGAVEREXX
FREQTABLEXX
GAINXX
GATEXX
GHOLDXX
GMODEXX
GMUTEXX
GRATIOXX
GREPORTXX
HCONFXX
HOOKXX
HOOKDXX
LABELXX
LOCALNUMXX
Page 4 of 56
Command NameInteract AT Interact Pro
LOGMASKXX
LVLXX
LVLREPORTXX
LVLREPORTENXX
MANUFACTURERXX
MICCAMPRESETX
MLINEXX
MMAXX
MTRXXX
MTRXCLEARX
MTRXLVLX
MUTEXX
NCDXX
NCSELXX
NLPXX
NOMX
OFFAXX
PAAXX
PBDIALXX
PHONEBOOKADDXX
PHONEBOOKCNTXX
PHONEBOOKDELXX
PHONEBOOKREADXX
PODUPDATEXX
PODVERXX
PPXX
PTTTHRESHOLDXX
PUSHTOTALKXX
RADIOENXX
RADIOSCANXX
RADIOSCANRESXX
RADIOSTATENXX
RADIOSTATSXX
RAMPXX
REDIALXX
REFSETX
RESETXX
Page 5 of 56
Command NameInteract AT Interact Pro
RESETUSBXX
RFVERXX
RINGXX
RINGERENXX
RINGERIGNX
RINGERLVLXX
RINGERSELXX
RINGERTESTXX
RXBOOSTXX
RXBSTENXX
SILENCEPRSTX
SPEEDDIALXX
SPLEVELX
SPLIFTX
STEREOMIXX
SYSCHECKSXX
SYSRESULTSXX
TEXX
TELCOLVLCTRLXX
TELSETXX
TIMELOCALEXX
TLECXX
TMX
TNLPXX
UIDXX
VERXX
VEREXX
VOLBUTX
VOLUMEXX
ZDIALXX
ZRINGXX
ZTEXX
Page 6 of 56
AA – Auto Answer Enable/ Disable
This command selects/reports the setting of auto answer.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
0 = Off
ValueUnsigned Integer2
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Off
ValueUnsigned Integer2
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
0 = Off
ValueUnsigned Integer2
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
0 = Off
1 = Loop Drop
ValueUnsigned Integer2
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Off
ValueUnsigned Integer2
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
NameTypeSizeValues
0 = Mono
ValueUnsigned Integer4
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
NameTypeSizeValues
ChannelChannel2
GroupGroup22, 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
NameTypeSizeValues
ChannelChannel2
GroupGroup22, 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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Off
ValueUnsigned Integer2
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
NameTypeSizeValues
ChannelChannel1See Groups and Channels
GroupGroup13 (M)
ValueSigned Float2
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
NameTypeSizeValues
ValueUnsigned Integer4
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
Reserved20
DurationString8String 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
NameTypeSizeValues
ValueUnsigned Integer4
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
NameTypeSizeValues
0 = Sony
ValueUnsigned Integer4
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
NameTypeSizeValues
0 = Off
ValueUnsigned Integer4
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.
1 – 4 for Group 5 (P)
(* for all in text, 0xff for all in binary)
0 = Off
1 = On
2 = Toggle
(Null to query in text)
FILTER – Filter Parameters
This command selects/reports the parameters for a filter on a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13, 5 (M, P)
NodeUnsigned Integer1
TypeUnsigned Integer1
FrequencyUnsigned Float4
GainSigned Float2
BandwidthUnsigned Float2
1 – 3 for Group 3 (M)
1 – 4 for Group 5 (P)
0 = NoneXX
1 = All PassXX
2 = Low PassXX
3 = High PassX
4 = Low ShelfX
5 = High ShelfX
6 = PEQXX
7 = CD HornX
11 = NotchXX
TypeValues
00 (NULL in text)
2 – 1120.00 to 20000.00 Hz
TypeValues
0 – 3, 110 (NULL in text)
6-15.00 15.00 dB
TypeValues
0 – 30 (NULL in text)
6, 110.05 – 5.00 Octaves
Group 3 (M)Group 5 (P)
TEXT FORM DETAILS
COMMAND FORM:DEVICE FILTER <Channel> <Node> [Type Frequency Gain Bandwidth]
FLOW – Flow Control
This command selects/reports the flow control of the serial port on the unit. Hardware flow control is
implemented using DTR and DSR.
ARGUMENT DETAILS
NameTypeSizeValues
0 = Off
ValueUnsigned Integer4
TEXT FORM DETAILS
COMMAND FORM:DEVICE FLOW [Value]
Page 26 of 56
1 = On
2 = Toggle
(Null to query in text)
FMP – First Mic Priority
This command selects/reports First Mic Priority Mode.
ARGUMENT DETAILS
NameTypeSizeValues
0 = Off
ValueUnsigned Short2
TEXT FORM DETAILS
COMMAND FORM:DEVICE FMP [Value]
1 = On
2 = Toggle
(Null to query in text)
FPGAVER – FPGA Version
This command reports the version of the FPGA code in the unit. This command is read only.
NameTypeSizeValues
ValueString12(Sent with a Null in text)
TEXT FORM DETAILS
FPGAVEREX – FPGA Version
This command reports the version of the FPGA code in the InteractPro8i unit. This command is read only.
ARGUMENT DETAILS
NameTypeSizeValues
ValueString12(Sent with a Null in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE FPGAVEREX [Value]
FREQTABLE – Frequency Table
This command sets or reports back the current frequency table.
ARGUMENT DETAILS
NameTypeSizeValues
ValueUnsigned Integer4
TEXT FORM DETAILS
COMMAND FORM:DEVICE FREQTABLE [Value]
1 – 8
(Null to query in text)
Page 27 of 56
GAIN – Gain Adjustment
This command changes or reports back the gain for a specified channel.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup1
ValueSigned Float2
Absol / Rel0
TEXT FORM DETAILS
COMMAND FORM:DEVICE GAIN <Channel> <Group> [Value] [Absol/Rel]
** Note: Values indicate entry range only. Actual internal range of the gain stage is from –14.00 to 18.00 dB
for Interact AT and from -65.00 to 20.00 dB for Interact PRO. Absolute values will be limited to the internal gain
range.
2, 3, 5, 7, 16, 17, 26, 27, 28, 29
(O, M, P, L, T, R, H, N, D, W)
-99.90 – 99.90 dB **
(Null to query in text)
A = Absolute
R = Relative
Null = Relative
GATE – Gate Status
This command reports the gate status of Mics. This command is read only.
ARGUMENT DETAILS
NameTypeSizeValues
ValueHexadecimal4
TEXT FORM DETAILS
COMMAND FORM:DEVICE GATE [Value]
Bits 0 – 15 represent gate status on Mics 1 – 16
(Null sent in text, Value returned)
GHOLD – Gate Hold Time
This command selects/reports the gate hold time for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
ValueUnsigned Float2
TEXT FORM DETAILS
COMMAND FORM:DEVICE GHOLD <Channel> [Value]
Page 28 of 56
0.10 – 8.000 s
(Null to query in text)
GMODE – Gating Mode
This command selects/reports the status of the gate mode for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Auto
1 = On
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE GMODE <Channel> [Value]
2 = Off
3 = Override On
(Null to query in text)
GMUTE – Global Mute
This command selects/reports the global mute for the microphones.
ARGUMENT DETAILS
NameTypeSizeValues
GroupGroup23 (M)
0 = Off
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE GMUTE <Group> [Value]
If setting, 0 will turn mute off all microphones and 1 will mute all microphones. If querying, a 1 means all
microphones are muted while a zero means at least 1 microphone is unmated.
1 = On
2 = Toggle
(Null to query in text)
GRATIO – Gate Ratio
This command selects/reports the ratio for gating for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE GRATIO <Channel> [Value]
Page 29 of 56
0 – 50 dB
(Null to query in text)
GREPORT – Gate Report
This command selects/reports the mode of gate status reporting.
ARGUMENT DETAILS
NameTypeSizeValues
0 = Off
ValueUnsigned Integer4
TEXT FORM DETAILS
COMMAND FORM:DEVICE GREPORT [Value]
1 = On
2 = Toggle
(Null to query in text)
HCONF – Headset Configuration
This command selects/reports the headset configuration for the unit.
ARGUMENT DETAILS
NameTypeSizeValues
ValuePin 1
03 VSpkrGndMicAvaya 4610
1Spkr+MicGndSpkr-Cisco 7940
2MicSpkrSpkrMic
(Null to query in text)
Pin Out
Speaker (RX)
Gain
Microphone (TX)
Gain
Unsigned
Integer
Signed
Integer
Signed
Integer
2
19, 6, 3, 0, -3,-6, -9, or -12 dB
19, 6, 3, 0, -3,-6, -9, or -12 dB
Pin
2
Pin
3
Pin 4
Supported
Headsets
NEC DT300,
DT700 Series
TEXT FORM DETAILS
COMMAND FORM:DEVICE HCONF [Pin Out Speaker Gain Mic Gain]
HOOK – Hook Flash
This command sends a hook flash. There is no query for this command.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
Reserved20
TEXT FORM DETAILS
COMMAND FORM:DEVICE HOOK <Channel>
Page 30 of 56
HOOKD – Hook Flash Duration
This command selects/reports the hook flash duration.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE HOOKD <Channel> [Value]
LABEL – Label
This selects/reports the label of the specific channel or the unit.
The all channel is not allowed. (See
GroupAndChannels)
2, 5, 16, 20, 26, 28
(O, P, T, B, H, D)
0 = Cross point off
1 = Cross point on (not valid for PRO Mics)
2 = Toggle (not valid for PRO Mics)
3 = Non Gated (PRO Mics only)
4 = Gated (PRO Mics only)
6 = Prohibited
(Null to query in text)
MTRXCLEAR – Matrix Clear
This command clears the matrix. There is no query for this command.
ARGUMENT DETAILS
NameTypeSizeValues
ValueReserved40
TEXT FORM DETAILS
COMMAND FORM:DEVICE MTRXCLEAR
MTRXLVL – Matrix Level
This command selects/reports the attenuation at a matrix crosspoint.
This command selects/reports the non-linear processing for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Off
1 = Soft
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE NLP <Channel> [Value]
2 = Medium
3 = Aggressive
(Null to query in text)
NOM – Number of Open Microphones
This command selects/reports the setting of number of open microphone level adjust for an output.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup12 (O)
0 = Off
ValueUnsigned Integer2
1 = On
2 = Toggle
(Null to query in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE NOM <Channel> <Group> [Value]
OFFA – Off Attenuation
This command selects/reports the off attenuation value for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
ValueUnsigned Float2
TEXT FORM DETAILS
COMMAND FORM:DEVICE OFFA <Channel> [Value]
0.00 – 60.00 dB
(Null to query in text)
Page 37 of 56
PAA – PA Adaptive
This command selects/reports the PA adaptive mode for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Off
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE PAA <Channel> [Value]
1 = On
2 = Toggle
(Null to query in text)
PBDIAL – Dial a PB Entry by Name
This command dials a speed dial number by name. There is no query for this command.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ReservedUnsigned Integer20
LabelString161 – 16 chars
TEXT FORM DETAILS
COMMAND FORM:DEVICE PBDIAL <Channel> <Label>
PHONEBOOKADD – Adds an Entry to the Phonebook
This command saves an entry in the phonebook. There is no query!! No two entries can share the same label.
An argument error will be returned if an entry already has the name. To change an entry, you must first delete
it and then add it again. If label is blank, the first 20 characters of the number will be used as the label.
Number must not be blank. If an entry already exists with the assigned speed dial it will be overwritten. The
rest of the entries are alphabetized base on Label.
If Rate = 0, the ramp will stop
If Rate < 0, the gain will ramp down
If Rate > 0, the gain will ramp up
-65.00 to +20.00 dB
If NULL in text (0x80) in binary, the ramp will use the gain range as
the target.
REDIAL – Dial the last number again
This command redials the last number. There is no query for this command.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
Reserved20
TEXT FORM DETAILS
COMMAND FORM:DEVICE REDIAL <Channel>
REFSET – Reference Set
This command selects/reports the output a virtual reference uses for gain tracking.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup1
Output ChannelChannel2See 2 (O) in GroupAndChannels
TEXT FORM DETAILS
COMMAND FORM:DEVICE REFSET <Channel.> [Output]
20
(B)
RESET – Reset
Resets the unit. There is no query for this command.
TEXT FORM DETAILS
COMMAND FORM: DEVICE RESET
Page 43 of 56
RESETUSB – Reset USB
This command resets the USB interface on the COM module and causes the USB to re-enumerate.
ARGUMENT DETAILS
NameTypeSizeValues
RsvdUnsigned Short4-
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.
ARGUMENT DETAILS
NameTypeSizeValues
ValueString12(Sent with a Null in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE RFVER [Value]
RING – Ring Indication
This command indicates a ringing line. This command is reportable only. It cannot be queried or set.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
0 = Ring cycle has stopped
1 = Ring cycle has begun
TEXT FORM DETAILS
COMMAND FORM:DEVICE RING <Channel><Value>
RINGEREN – Ringer Enable
This command selects/reports the status of the audible ring indication.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
0 = Off
Value
TEXT FORM DETAILS
COMMANDFORM:DEVICERINGEREN <Channel>
Unsigned Integer
2
Page 44 of 56
1 = On
2 = Toggle
(Null to query in text)
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
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
Group
Reserved-2
TEXT FORM DETAILS
COMMANDFORM:DEVICERINGERIGN <Channel>
Group
13 (R)
RINGERLVL – Audible Ring Level
This command selects/reports the audible ring’s level.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueSigned Float2
-12.00 – 4.00 dB
(Null to query in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE RINGERLVL <Channel> [Value]
RINGERSEL – Audible Ring Melody Selection
This command sends/reports the audible ring melody.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE RINGERSEL <Channel> [Value]
1 – 3 (Null to query in text)
RINGERTEST – Audible Ring Melody Test
This command plays the current audible ringer melody. This command is executable only. There is no query.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ReservedUnsigned Integer20
TEXT FORM DETAILS
COMMAND FORM:DEVICE RINGERTEST <Channel>
Page 45 of 56
RXBOOST – Receive Boost
This command selects/reports the receive boost status.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE RXBOOST<Channel> <Value>
RXBSTEN – Receive Boost Enable
This command enables/disables the receive boost.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
0, 3, 6, 9, or 12 dB
(Null to query in text)
0 = Off
1 = On
2 = Toggle
(Null to query in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE RXBSTEN<Channel> <Value>
Page 46 of 56
SILENCEPRST – Silence Camera Preset
This command associates a camera preset with silence for voice tracking.
ARGUMENT DETAILS
NameTypeSizeValues
0 to Clear
ValueUnsigned Integer4
TEXT FORM DETAILS
COMMAND FORM:DEVICE SILENCEPRST [Value]
1 – 10
(NULL to Query in Text)
SPEEDDIAL – Speed Dialing
This command dials a speed dial number by speed dial number. There is no query for this command.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE SPEEDDIAL <Channel> <Value>
1 – 33
34 for Conference
SPLEVEL – Speech Lift Level
This command selects/reports the level of speech lift for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
ValueSigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE SPLEVEL <Channel> [Value]
-18 – 0 dB
(Null to query in text)
Page 47 of 56
SPLIFT – Speech Lift Mode
This command selects/reports the status of the speech lift mode for a microphone.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup13 (M)
0 = Off
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE SPLIFT <Channel> [Value]
1 = On
2 = Toggle
(Null to query in text)
STEREOMIX – Sets the Input to be a Stereo Mix
This command enables / disables or reports the stereo mix status of an input.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup17 (L)
0 = On
ValueUnsigned Integer2
1 = Off
2 = Toggle
(NULL to query in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE STEREOMIX <Channel> [Value]
SYSCHECKS – System Checks
Initiates the system checks. There is no query for this command.
3 = Speaker
4 = Telephone
5 = Network
6 = USB
All other bits reserved.
0 = Fail
1 = Pass
For the Break Out Boxes: this message will say if a box is not
connected.
If a box is connected, the message will say which microphones
fail. If none fail, the message will say that all microphones pass.
For the speakers: the message will say if the speakers fail. If they,
pass but are out of phase, the message will say they are out of
phase.Otherwise, the message will say the speakers pass.
For the telephone on hook: the message will report the line
voltage, the line current, other results, and if dial tone is detected.
For the telephone off hook: the message will report the line
current, other results, and if dial tone is detected.
The bit mask for the other results is
xxxx xxxx
| | | | | | | |--> set if switched from CTR21 to FCC because of
low current
| | | | | ||--> set if used DIAL bit while dialing
| | | | ||--> set if switch from Low Voltage to Japan because of
current
| | | | |--> set if switch from Low Voltage to FCC because of
current
| | ||--> DAA OVL status
| ||--> DAA DOD status
||--> DAA OPD status
|--> Not used
For the network check: the box will report if no IP address is set. If
it is set, the box will ping the gateway. The message will say the
ping failed if it is not returned in 5 seconds. Otherwise, the
message will report how many seconds it took to return the ping.
Page 49 of 56
TE – Telco Enable
This command selects/reports the hook status.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
GroupGroup117 (R)
0 = Off
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE TE <Channel> [Value]
1 = On
2 = Toggle
(Null to query in text)
TELCOLVLCTRL – Telco RX Level Control Enable/ Disable
This command selects/reports the setting of Telco RX level control.
0 = Custom (HCONF sets parameters)
1 = Avaya 2400 Series
2 = Avaya 4600 Series
3 = Avaya 9600 Series
4 = Cisco 7900 Series
5 = Nortel 1100 Series
6 = Nortel 2000 Series
7 = NEC DT300
8 = NEC DT700
(Null to query in text)
TIMELOCALE – Time Locale Settings
This command sets or reports the time locale settings.
ARGUMENT DETAILS
NameTypeSizeValues
0 = Do not use Daylight Savings
Daylight SavingsUnsigned Integer4
Time ZoneUnsigned Integer4The number of seconds from UDT. (-86400 – 86400)
This command reports the unit id. This command is read only.
ARGUMENT DETAILS
NameTypeSizeValues
ValueHexadecimal4(Sent with a Null, value returned in text)
TEXT FORM DETAILS
COMMAND FORM:DEVICE UID [Value]
VER – Version
This command reports the version of the unit. This command is read only.
ARGUMENT DETAILS
NameTypeSizeValues
ValueString8
TEXT FORM DETAILS
COMMAND FORM:DEVICE VER [Value]
Version of format MM.mm.rr
(Sent with a Null in text, value returned)
VEREX – Firmware Version
This command reports the version of the InteractPRO8I unit. This command is read only.
ARGUMENT DETAILS
NameTypeSizeValues
ValueString8
TEXT FORM DETAILS
COMMAND FORM:DEVICE VEREX [Value]
Version of format MM.mm.rr
(Sent with a Null in text, value returned)
Page 52 of 56
VOLBUT – Volume Button
This command sets or reports the channel assigned to the volume button or command.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel2
GroupGroup22, 5 (O, P)
TEXT FORM DETAILS
COMMAND FORM:DEVICE VOLBUT [Channel Group]
See GroupAndChannels
(Null to query in text)
VOLUME – Volume Adjustment
This command changes or reports back the gain for the output channel set as the EC reference.
ARGUMENT DETAILS
NameTypeSizeValues
ValueSigned Float4
Absol / Rel0
TEXT FORM DETAILS
COMMAND FORM:DEVICE VOLUME [Value] [Absol/Rel]
** Note: Values indicate entry range only. Actual internal range of the gain stage is from –14.00 to 18.00 dB
for the Interact AT and -65.00 to 20.00 dB for the Interact PRO. Absolute values will be limited to the internal
gain range.
-99.90 – 99.90 dB **
(Null to query in text)
A = Absolute
R = Relative
Null = Relative
ZDIAL – DTMF Dialing USB
This command dials a DTMF sequence or reports back the last sequence dialed.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
Reserved20
NumberString44
TEXT FORM DETAILS
COMMAND FORM:DEVICE ZDIAL <Channel> [Number]
1 – 44 Chars of ‘0’ – ‘9’, ‘A’ – ‘D’, ‘*’, ‘#’, ‘,’
(Null to query last number dialed in text)
Page 53 of 56
ZRING – Ring Indication USB
This command indicates a ringing line. This command is reportable only. It cannot be queried or set.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE ZRING <Channel><Value>
0 = Ring cycle has stopped
1 = Ring cycle has begun
ZTE – Telco Enable USB
This command selects/reports the hook status.
ARGUMENT DETAILS
NameTypeSizeValues
ChannelChannel1See GroupAndChannels
0 = Off
ValueUnsigned Integer2
TEXT FORM DETAILS
COMMAND FORM:DEVICE ZTE <Channel> [Value]
1 = On
2 = Toggle
(Null to query in text)
Error Messages
The following lists possible error messages with their explanation:
Error
#
1Memory errorThe box is out of internal memory. Power cycle the box.
2
3
4
5Argument errorThe command had an argument that was out of range.
6
7Bad ChecksumThe binary command’s checksum was wrong.
8
11
Text MessageExplanation / Possible Solution
No command
found
Unknown
command
response
Not
implemented
Unknown
command
Camera Not
Responding
Command Too
Big
A command was not found in the string.
A command was executed on a different device type that this box cannot
display. The command dictionary needs to be updated.
The command is not implemented.
The command is not know to the box.
The camera is not responding to the commands sent.
The binary command is too large.
Page 54 of 56
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.
Group and Channels
GroupAlpha#
Unknown?0N/AN/A
OutputsO2
MicrophoneM31 – 9
Processing ChannelsP5N/AA - C
Line InputsL7
UnitU9
MatrixX1100
PhonebookK1300
OSA15
TransmitT1611
ReceiveR1711
Local CameraV19
Virtual ReferenceB20N/A1-2
PresetS25N/A1 – 4
Headset Out
(Microphone)
Headset In (Speaker)N27N/A1
USB OutD2811
USB InW2911
H26N/A1
INTERACT AT
Channel Range
1 – 3
1 is Record Out
2 is Line Out
3 is Speaker Out
1 – 2
1 is Record In
2 is Line In
0 for Unit Values
1 for Log
2 for HTML skin
3 for Firmware
4 for Directory
5 for Firmware Data
Sony Mode: 1 – 7
Canon Mode: 1 – 9
1 – 8
1 – 8 if no INTERACT Pro 8i
1 – 16 if INTERACT Pro 8i connected
1 – 2
0 for Unit Values
1 for Log
2 for HTML skin
3 for Firmware
4 for Directory
5 for Firmware Data
6 for Interact Pro 8i Firmware
7 for Interact Pro 8i Directory
8 for Interact Pro 8i Firmware Data
N/A
INTERACT PRO
Channel Range
Page 55 of 56
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).
Interact AT Meter Type Definitions
Level
AlphaNumeric
A2
R5
E6
T7ERL + ERLEN/AN/A
B12
position for
Microphones
Level after
processing
Echo Return
Loss
Echo Return
Loss
Enhancement
Pre PEQ,
Post Gain
Level position for
Line Inputs and
Outputs
Level after PEQ
and gain
N/AN/A
N/AN/A
N/AN/A
Level position for U SB In, USB
Out, Telco Receive & Telco
Level after gain
Transmit
Interact PRO Meter Type Definitions
Level for Line
Inputs, Outputs,
AlphaNumeric
I1InputInputInput
A2After GainAfter GainAfter GainOutput
N3Output Level
G4After Gate
R5
E6
T7
Level of
Microphones
Echo Return
Loss (Room
Loss or ERL)
Echo Return
Loss
Enhancement
(ERLE)
Total Echo
Return Loss
(ERL+
ERLE)
USBIn, USB
Out, Headset
In, Headset Out
&Telco TX
Level for
Telco RX
Echo Return
Loss (ERL)
Echo Return
Loss
Enhancement
(ERLE)
Total Echo
Return Loss
(ERL+
ERLE)
Level for
Virtual
Reference
Processing
Input to
compressor
Amount of
Compression
Level for
Channels
Page 56 of 56
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.