Clearone Converge Pro Serial User Manual

Browse online or download User Manual for Audio accessories Clearone Converge Pro Serial. ClearOne Converge Pro Serial User Manual

  • Download
  • Add to my manuals
  • Print
  • Page
    / 79
  • Table of contents
  • BOOKMARKS
  • Rated. / 5. Based on customer reviews
Page view 0
228
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
N 0-F
CONVENTIONS
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.
Page view 0
1 2 3 4 5 6 ... 78 79

Summary of Contents

Page 1 - COMMAND FORM DESCRIPTION

228APPENDIX A: APPLICATION PROGRAMMER’S INTERFACETYPE AND DEVICE IDSConverge/Converge Pro Device Types and Device IDs by model are as follows:Model

Page 2 - GROUPS AND CHANNELS

237SERIAL COMMANDSSerial commands are shown in bold, followed by the command form and argument details.AA – Auto Answer Enable / DisableThis command

Page 3 - METER TYPE DEFINITIONS TABLE

238ACONNLVL – Audible Connect / Disconnect LevelThis command selects/reports the audible connect / disconnect indicator’s level.Command Form: DEVICE

Page 4

239ADPRESENT – Audio PresenceThis command displays the channels that currently have valid audio signals present. This command is read only.Command

Page 5

240AGCSET – Automatic Gain Control AdjustThis command selects/reports the settings of the Automatic Gain Control.Command Form: DEVICE AGCSET <Cha

Page 6

241AVG – Adaptive Volume GainThis command sets the maximum gain setting that the algorithm will not exceed.Command Form: Argument Type Size Values

Page 7

242BFBINFO – Beamforming Array Beam Information This command reports the given Beamforming Array’s current active beams. This command is read only.

Page 8

243BFZONE – Manually Disables/Enables Beamforming Mic Zones For each Mode of a Beamforming Mic manually Enable or Disable each of the Mic Zones.Comm

Page 9

244CALLDUR – Call DurationThis command returns current call duration. If no call is active, this command returns 0. At the time of call termination,

Page 10 - SERIAL COMMANDS

245CLEAREFFECT – ClearEffect Wide Band Telco EmulationThis command enables / disables or reports the current status of the ClearEffect.Command Form:

Page 11 - ADCLIP – Audio Clipping

246COMPRESS – Compressor AdjustThis command selects/reports the settings of the compressor.Command Form: DEVICE COMPRESS <Channel> [Threshold

Page 12 - AGC – Automatic Gain Control

229If an asterisk (*) is placed in the Device Type or Device ID fields, the command will apply to all units or all devices respectively. For exampl

Page 13

247DECAY – Decay AdjustThis command selects/reports the setting of the decay rate.Command Form: DEVICE DECAY <Channel> [Value] Argument Type S

Page 14

248DEVICESUBTYPE – Sets the Subtype of a Connected DeviceThis command enables/disables or reports the current type of device connected to an input o

Page 15

249DID – Device IDThis command reports the device id. This command is read only except through the front panel.Command Form: DEVICE DID [Value]Argum

Page 16

250ENETDHCP – Ethernet DHCP SelectionThis command selects/reports the use of DHCP of the Ethernet port on the unit.Command Form: DEVICE ENETDHCP [Va

Page 17 - CALLDUR – Call Duration

251ENETVLAN – Enable VLAN TaggingThis command enables/disables VLAN tagging. Valid on VH20 ONLY. Change requires reboot to become effective.Command

Page 18 - CLOCK – Clock Set

252FE – Feedback Elimination EnableThis command enables or disables feedback elimination on the power amplifier channel.Command Form: DEVICE FE <

Page 19 - COUNTRY – Country Selection

253FEGL – Feedback Elimination Gain LevelThis command reports the gain value achieved at the end of the feedback automatic setup. The maximum value

Page 20

254FERNG – Feedback Elimination Ring Elimination ModeThis command enables/disables the Ring Elimination Mode on the feedback eliminator.Command Form

Page 21

255FILTER – Filter AdjustThis command selects/reports the settings of a filter.Command Form: DEVICE FILTER <Channel> <Group> <Node>

Page 22

256FLOW – Flow ControlThis command selects/reports the flow control of the serial port on the unit. Hardware flow control is implemented using DTR a

Page 23

230METER TYPE DEFINITIONS TABLEA L P H ALevel Position for:MicsBeam-forming Mic ArrayLine Inputs Outputs Telco TX Telco Rx Faders Processors Power A

Page 24

257GMODE – Gating ModeThis command selects/reports the setting of gating mode.Command Form: DEVICE GMODE <Channel> [Value] Argument Type Size

Page 25

258GRPSEL – Gating Group SelectThis command selects/reports which Gating Group a microphone input is assigned.Command Form: DEVICE GRPSEL <Channe

Page 26

259HDNLP – Non Linear Processing AdjustThis command selects/reports the setting of the Non-linear processing for each microphone channel. This comma

Page 27

260LMO – Last Mic On ModeThis command selects/reports last Mic on mode.Command Form: DEVICE LMO <Channel> [Value] Argument Type Size Values Un

Page 28 - FILTSEL – Filter Select

261LOCCOMP – Location: CompanyThis command sets/reports the location of the unit: Company string.Command Form: DEVICE LOCCOMP [Value] Argument Type

Page 29

262LOGMASK – Device Log MaskThis command sets or reports the device event log mask.Command Form: DEVICE LOGMASK [Value]Argument Type Size Values Uni

Page 30

263LVLREPORTEN – Level Report EnableEnables level reporting for the unit.Command Form: DEVICE LVLREPORTEN [Value] Argument Type Size Values UnitsVal

Page 31

264MC – Multi-Channel ModeThis command groups audio controls for channels. Audio Controls include Gain, Ramp Gain, and Mute.Command Form: DEVICE M

Page 32

265MCMUTE – Multi-Channel Min and Max Gain SettingThis command performs/reports audio mutes of the grouped channels.Command Form: DEVICE MCMUTE <

Page 33

266MLINE – Mic / Line Coarse Gain SettingThis command selects/reports the setting of coarse gain.Command Form: DEVICE MLINE <Channel> [Value]

Page 34

231SERIAL COMMAND INDEXAA – Auto Answer Enable / Disable ...237AAMB – Adaptive Ambient Mode ...

Page 35 - LVLREPORT – Level Report

267MTRX – Matrix RoutingThis command selects/reports the matrix routing of an input to an output.Command Form: DEVICE MTRX <Src. Ch.> <Src

Page 36

268MTRXTYPE – Select Pre-AEC Gated or Non-Gated RoutingThis command selects whether the Pre-AEC routing is Gated or Non-Gated.Command Form: DEVICE

Page 37

269NLP – Non Linear Processing AdjustThis command selects/reports the setting of non-linear processing for each microphone channel.Command Form: DEV

Page 38

270PAA – PA Adaptive ModeThis command selects/reports PA adaptive mode for the specified Mic.Command Form: DEVICE PAA <Channel> [Value]Argumen

Page 39

271PAEQRST – PA EQ Filter ResetThis command resets the EQ Level for ALL bands in the filter bank. There is no query associated with this command.Co

Page 40 - MTRXCLEAR – Clear Matrix

272PALEN – PA Limiter Enable This command changes enables the Limiter on a power amplifier channel.Command Form: DEVICE PALEN <Channel> <G

Page 41

273PANGM – PA Noise Gate Mode This command sets the Noise Gate mode to be either manual or automatic. In manual mode the gate threshold will be use

Page 42

274PASML – PA Sound Mask Level This command selects/reports the sound mask level on a PA channel.Command Form: DEVICE PASML <Channel> <Gro

Page 43 - PAEQEN – PA EQ Filter Enable

275PHONEBOOKADD – Adds an Entry to the PhonebookThis command saves an entry in the phonebook. There is no query for this command. No two entries c

Page 44 - PAFLT – PA Fault

276PRESET – Preset Execution/ReportingThis command selects/reports the state of a preset.Command Form: DEVICE PRESET <Channel> [Value]Argument

Page 45

232DELAY – Delay Adjust ...247DELAYSEL – Delay Select...

Page 46

277PTTTHRESHOLD – Push to Talk ThresholdThis command selects/reports the setting of the push to talk threshold for a microphone.Command Form: DEVICE

Page 47

278REFSET – Reference Channel Set UpThis command selects/reports the output the reference channel tracks.Command Form: DEVICE REFSET <Channel>

Page 48

279RINGERTEST – Audible Ring Melody TestThis command plays the current audible ringer melody. This command is executable only. There is no query.Co

Page 49

280RXBOOST – Receive BoostThis command selects/reports the receive boost status.Command Form: DEVICE RXBOOST <Channel> [Value]Argument Type Si

Page 50

281SIGGEN – Signal GeneratorThis command selects/reports of the signal generator activation.Command Form: DEVICE SIGGEN [Channel Group Type Amplitud

Page 51

282SLVL – Speech Level ControlThis command selects/reports the setting of Speech Level Control.Command Form: DEVICE SLVL <Channel> [Value] Arg

Page 52 - RINGMOD – Ring Cadence Mode

283SPEEDDIAL – Speed Dial a NumberThis command dials a speed dial number.Command Form: DEVICE SPEEDDIAL <Channel> [Value]Argument Type Size Va

Page 53 - SFTYMUTE – Safety Mute

284SYSRESULT – System Check ResultThis command reports the results of the system check. This command is reportable only. It cannot be queried or se

Page 54 - SIGGEN – Signal Generator

285TAMODE – Telco Adapt ModeThis command selects/reports the Telco adapt mode.Command Form: DEVICE TAMODE <Channel> [Value]Argument Type Size

Page 55

286TOUT – Time Out SelectThis command selects/reports the inactivity time out before returning to the unit title screen on the front panel.Command F

Page 56 - SYSCHECKS – System Checks

233GHOLD – Gate Hold Time Adjust ...256GMODE – Gating Mode...

Page 57

287XAMBLVL – Ambient Level AdjustThis command selects/reports the ambient level. This command can be used to replace the AMBLVL command for the M gr

Page 58

288XCALLDUR – Call DurationThis command indicates how long a call has lasted. If no call is in session, this will report 0. At the time of call term

Page 59

289XCOMPRESS – Compressor AdjustThis command controls/reports the signal compression setting on a Channel. This command can be used to replace the C

Page 60

290XDELAYSEL – Audio Delay EnableThis command enables signal delay on a Channel. This command can be used to replace the DELAYSEL command for the P

Page 61 - XCGROUP – Compressor Group

291XDTONELVL – Dial Tone LevelThis command selects/reports the audible dial tone’s level. This command can be used to replace the DTONELVL command f

Page 62 - XDELAY – Audio Delay

292XGRPSEL – Gating Group SelectThis command selects/reports which Gating Group a microphone input is assigned. This command can be used to replace

Page 63 - XDTMFLVL – DTMF Tone Level

293XOFFA – Off Attenuation ModeThis command selects/reports the off attenuation value of a Mic channel. This command can be used to replace the OFFA

Page 64

294XRINGERLVL – Audible Ring LevelThis command selects/reports the audible ring’s level. This command can be used to replace the RINGERLVL command f

Page 65 - XLOCALNUM – Local Number

295XTE – Telco EnableThis command selects/reports the hook status. This command can be used to replace the TE command for the R group.Command Form:

Page 66

296CALL CONTROL SERIAL COMMANDSCALLSTATUS – Report the Status of VoIP ChannelsThis command gives the status of the VoIP channels. This status can be

Page 67

234MTRX – Matrix Routing...267MTRXTYPE – Select Pre-AEC Gated or Non-Gated Routing ...

Page 68 - XTE – Telco Enable

297CONFSTART – Initiates a 3-Way Conference CallThis command dials a 3rd party to initiate a bridged (conferenced) call.Command Form Details:DEVICE

Page 69 - CALL CONTROL SERIAL COMMANDS

298TRANSCANCEL – Cancels a Transferred CallThis command interrupts/stops a transfer. There is no query for this command.Command Form Details:DEVICE

Page 70 - HOLD – Places a Call on Hold

299SERIAL COMMAND SUPPORT TABLEThe following table shows serial command support by Converge/Converge Pro device type. Note that Telco-related comman

Page 71 - VE – VoIP Enable

300COMMAND NAMEDEVICEPro 880Pro 880TPro 840TPro 8iPro TH20SR 1212880TASR 1212APro VH20Beam-forming Mic ArrayDECAY X X X X X X XDEFAULT X X X X X X X

Page 72 - SERIAL COMMAND SUPPORT TABLE

301COMMAND NAMEDEVICEPro 880Pro 880TPro 840TPro 8iPro TH20SR 1212880TASR 1212APro VH20Beam-forming Mic ArrayFLOW X X X X X X X X XFMP X X X X X X XG

Page 73

302COMMAND NAMEDEVICEPro 880Pro 880TPro 840TPro 8iPro TH20SR 1212880TASR 1212APro VH20Beam-forming Mic ArrayMLINE X X X X X X XMMAX X X X X X X XMOD

Page 74

303COMMAND NAMEDEVICEPro 880Pro 880TPro 840TPro 8iPro TH20SR 1212880TASR 1212APro VH20Beam-forming Mic ArrayPP X X X X X X XPRESET X X X X X X X X X

Page 75

304COMMAND NAMEDEVICEPro 880Pro 880TPro 840TPro 8iPro TH20SR 1212880TASR 1212APro VH20Beam-forming Mic ArrayTRANSSTART XUID X X X X X X X X X XVE XV

Page 76

305ALL MODELS: RS-232 PORTCONNECTING WITH TELNETUsers can connect to any unit via RS-232 and telnet. Available telnet commands are the same as those

Page 78 - CONNECTING WITH TELNET

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

Page 79

236XAA – Auto Answer Enable/Disable ..............286XAAMB – Adaptive Ambient Mode .......

Comments to this Manuals

No comments