Clear One CONVERGE PRO 2 Manuel utilisateur

Reference Manual

CONVERGE PRO 2 Serial Commands

DOC-0293-001 v.1.9 October 2020

Supported Products:

CONVERGE Pro 2 Devices

Notices

CONVERGE Pro 2 Serial Commands Reference Manual

ClearOne Part Number: DOC-0293-001 (Revision 1.9) October 2020

product names may be registered trademarks of their respective owners who do not necessarily endorse ClearOne or

ClearOne’s products in the United States and/or other countries.

Contents

TOCbookmark

Notices ...................................................................................................................... 2

1. Concepts ..........................................................................................................................8

1.1 Introduction ......................................................................................................................8

1.2 Connection to the Device .............................................................................................8

1.2.1 Serial Port Connection.................................................................................................. 8

1.2.2 Telnet Connection ........................................................................................................... 8

1.3 End Points.........................................................................................................................9

1.3.1 End Point Types.............................................................................................................. 9

1.3.2 End Point Numbering.................................................................................................. 10

1.4 Syntax Conventions .....................................................................................................10

1.4.1 Command-level Syntax Conventions....................................................................... 10

1.4.2 Parameter-level Syntax Conventions...................................................................... 11

1.5 Input/Output....................................................................................................................12

1.5.1 Input................................................................................................................................. 12

1.5.2 Output ............................................................................................................................. 13

1.5.3 BEAM Command and BEAMREPORT Output....................................................... 13

1.5.4 Asynchronous Notifications ...................................................................................... 13

1.6 Text vs. Numerical Parameters .................................................................................14

1.7 Read/Write Modes ........................................................................................................14

1.7.1 Write Mode..................................................................................................................... 14

1.7.2 Read Mode..................................................................................................................... 14

1.7.3 Meaning of RWC........................................................................................................... 15

1.8 Channel Labels and Groups......................................................................................15

1.8.1 Use of CONSOLE AI to Create Labels and Groups............................................. 15

1.9 CP2 Touch Panel Controller and Serial Commands ..........................................15

1.9.1 Volume Up Settings ..................................................................................................... 16

Contents

TOCbookmark

1.9.2 Volume Down Settings................................................................................................ 16

1.9.3 Slider Position Settings.............................................................................................. 17

1.9.4 Mute Settings ................................................................................................................ 17

Chapter 2 - Reference......................................................................................... 18

2.1 STACK ..............................................................................................................................18

2.1.1 Stack Function, Syntax, Parameters......................................................................... 18

2.1.2 Stack Command Table ................................................................................................ 18

2.1.3 Stack-SYSTEM (1)........................................................................................................ 19

2.1.4 Stack-ADMIN (9)........................................................................................................... 20

2.1.5 Stack-CLOCK (5) .......................................................................................................... 21

2.1.6 Stack-LOCATION (6).................................................................................................... 22

2.1.7 Stack-SMTP (8) ............................................................................................................. 24

2.1.8 Stack-SNMP_MGR (10)............................................................................................... 25

2.2 BOX ...................................................................................................................................26

2.2.1 Box Function, Syntax, Parameters............................................................................ 27

2.2.2 Box Command Table..................................................................................................... 27

2.2.3 Box-DANTE (7) ............................................................................................................... 31

2.2.4 Box-ETHERNET_PORT (6) ......................................................................................... 33

2.2.5 Box-LOCATE (18) ......................................................................................................... 37

2.2.6 Box-NOTIFICATION (8)............................................................................................... 37

2.2.7 Box-PLINK (19) ............................................................................................................. 38

2.2.8 Box-SERIAL_PORT (5) ................................................................................................ 39

2.2.9 Box-UNIT (1) .................................................................................................................. 40

2.2.10 Box-USB_PORT (17).................................................................................................. 42

2.2.11 Box-VLAN_VOIP (9) ................................................................................................... 43

2.2.12 Box-VOIP_CFG (10) ................................................................................................... 46

2.2.13 Box-VOIP_CONNECT (16)........................................................................................ 48

Contents

TOCbookmark

2.2.14 Box-VOIP_PORT (15)................................................................................................. 49

2.2.15 Box-TEMP..................................................................................................................... 52

2.2.16 Box-FAN........................................................................................................................ 53

2.3 ROOM ...............................................................................................................................54

2.3.1 ROOM Function, Syntax, Parameters ..................................................................... 54

2.3.2 Room Command Table ............................................................................................... 54

2.3.3 ROOM-Divider Polarity (12)....................................................................................... 55

2.3.4 ROOM-Divider State (13)............................................................................................ 55

2.3.5 Room-Individual Divider State (11) ......................................................................... 57

2.3.6 ROOM-Mode(1)............................................................................................................. 57

2.3.7 ROOM-Select (7) .......................................................................................................... 58

2.4 EP.......................................................................................................................................60

2.4.1 EP Command Table ..................................................................................................... 61

2.4.2 BFM.................................................................................................................................. 93

2.4.3 BMA360......................................................................................................................... 106

2.4.4 BMA360_SPKR............................................................................................................ 126

2.4.5 BTE_RX ......................................................................................................................... 131

2.4.6 BTE_TX.......................................................................................................................... 132

2.4.7 CTBFM .......................................................................................................................... 134

2.4.8 CTBFM_SPKR ............................................................................................................. 149

2.4.9 D20MIC ......................................................................................................................... 153

2.4.10 DANTE_RX ................................................................................................................. 163

2.4.11 DANTE_TX.................................................................................................................. 164

2.4.12 EXP_BT ....................................................................................................................... 165

2.4.13 EXP_D20MIC ............................................................................................................. 167

2.4.14 EXP_GPIO .................................................................................................................. 180

2.4.15 EXP_USB.................................................................................................................... 185

2.4.16 FADER......................................................................................................................... 190

Contents

TOCbookmark

2.4.17 GPIO............................................................................................................................ 191

2.4.18 MIC .............................................................................................................................. 192

2.4.19 PROC .......................................................................................................................... 218

2.4.20 SPEAKER ................................................................................................................... 228

2.4.21 SRMIC......................................................................................................................... 239

2.4.22 TELCO_RX ................................................................................................................. 250

2.4.23 TELCO_TX.................................................................................................................. 266

2.4.24 UA................................................................................................................................. 268

2.4.25 USB_RX ...................................................................................................................... 299

2.4.26 USB_TX....................................................................................................................... 301

2.4.27 USBE_RX.................................................................................................................... 302

2.4.28 USBE_TX .................................................................................................................... 305

2.4.29 VOIP_RX ..................................................................................................................... 306

2.4.30 VOIP_TX...................................................................................................................... 308

2.5 RAMP ..............................................................................................................................309

2.6 MT ....................................................................................................................................311

2.7 CLRMATRIX ..................................................................................................................312

2.8 FILTER ............................................................................................................................312

2.9 GATE ...............................................................................................................................315

2.10 GATEGROUP..............................................................................................................317

2.11 METER .........................................................................................................................320

2.12 METERPRESENT ......................................................................................................321

2.13 MCCF............................................................................................................................321

2.14 VERSION .....................................................................................................................321

2.15 RESET ..........................................................................................................................322

2.16 FACTORYDEFAULT ..................................................................................................323

Contents

TOCbookmark

2.17 BEAM............................................................................................................................323

2.18 CLOCK .........................................................................................................................325

3. Change History ............................................................................................. 326

Rev 1.9, October 2020 .......................................................................................................326

Rev. 1.8, March 2018..........................................................................................................327

Rev. 1.7, March 2018..........................................................................................................327

Rev. 1.6, October 2017 ......................................................................................................328

ClearOne Contacts ............................................................................................ 330

CONVERGE Pro 2 Serial Commands

8DOC-0293-001 v.1.9 October 2020

Reference Manual

Back to Table of Contents

1. Concepts

1.1 Introduction

This document describes the serial commands for CONVERGE Pro 2.

CONVERGE Pro 2 lets you connect and control a wide variety of audio devices, which are referred to as end points.

You can use the CONSOLE AI software to configure and control a device or a stack of connected devices.

You may also connect to a CONVERGE Pro 2 device through a serial port or telnet connection. This makes available via

CONSOLE AI a subset of the control and configuration.’

This manual describes the available serial commands. More information about using CONSOLE AI is available in

the CONVERGE Pro 2 CONSOLE AI User Manual.

Note the following:

• Some of the command/parameter combinations described in this document apply only to certain

CONVERGE Pro 2 models.

• For example, commands that control analog phone signals (TELCO_RX, for telco receive and TELCO_TX,

for telco transmit) are applicable only if you are using a CONVERGE Pro 2 model with a telco phone jack

(model numbers that include a “T”)

• Commands for controlling VoIP are available only when you are using a CONVERGE Pro 2 model with

VoIP capability (model numbers that include a “V”); and so forth.

1.2 Connection to the Device

You can connect to a CONVERGE Pro 2 device via its serial port or via telnet session.

1.2.1 Serial Port Connection

To communicate with a box via its serial port, attach an RS-232 cable to the box’s serial port. Use the following

serial settings:

Setting Value

Baud Rate 57600

Data Bits 8

Stop Bits 1

Parity none

Flow Control none

Important: To ensure proper operation and response when using the Converge Pro 2’s RS-232 serial port,

commands should be sent no faster than every 150mS.

This time allows for the unit to decode and process the command while maintaining numerous other internal tasks.

Serial commands that are received by the Converge Pro 2 at a rate faster than 150mS may be automatically

discarded by the unit.

1.2.2 Telnet Connection

CONVERGE Pro 2 Serial Commands

9DOC-0293-001 v.1.9 October 2020

Reference Manual

Back to Table of Contents

To communicate with a box via telnet session, attach an Ethernet cable to the box’s LAN port. You can then

initiate a telnet session with the box on port 23. The default username is “clearone” and the default password is

“converge”. However, if you have changed the username or password using the CONSOLE AI, you must use that

username/password combination to telnet to the box.

Note: You can have up to five concurrent telnet sessions with a box.

1.3 End Points

End Points are audio channels that can be controlled and linked using CONVERGE Pro 2.

End points can be input devices (for audio input), output devices (for audio output), both (for processing audio, so

they are both input devices and output devices), or neither (for example, signal generators).

1.3.1 End Point Types

The tables below describe the types of end points:

1.3.1.1 Input End Points

Input end points are devices that allow audio input. Possible input end points include:

Device End Point Type

Microphones MIC

ClearOne Beamforming Microphone Array 2 BFM

Telephone (analog) In TELCO_RX

USB In USB_RX

Voice Over IP In VOIP_RX

1.3.1.2 Output

Output end points are devices that allow audio output. Possible output end points include:

Device End Point Type

Speakers SPEAKER

Output (any device attached to the output

ports on the device)

OUTPUT

Telephone (analog) Out TELCO_TX

USB Out USB_TX

Voice Over IP Out VOIP_TX

1.3.1.3 Other

Some end points are both input and output devices, or neither:

Device End Point Type

Fader FADER

GPIO (to control the GPIO pins on the box) GPIO

Processing Block PROC

User Agent (for controlling VOIP) UA

CONVERGE Pro 2 Serial Commands

10 DOC-0293-001 v.1.9 October 2020

Reference Manual

Back to Table of Contents

Signal Generator SGEN

1.3.2 End Point Numbering

For use in CONVERGE Pro 2 Serial commands, end points are numbered as follows:

BNN

where B is the number of the box in the stack and NN is the end point number.

For example, the diagram below shows the channel number for microphones in a stack that has four CONVERGE

Pro 2 devices with four microphones attached to device 1 in the stack, four microphones attached to device 3 in

the stack, and two microphones attached to device 4 in the stack:

The same numbering scheme applies to all the end point types described under End Point Types above.

If you wanted to mute the level of the third microphone attached to Device 1 in the stack, you would send the

following command:

EP MIC 103 LEVEL MUTE 1

Tip: While you can use channel numbers in commands, ClearOne strongly recommends using channel labels

rather than channel numbers. For more information, see Channel Labels and Groups.

Note: Device numbering can be difficult to determine, since it is not related to the order in which you

attach the devices or their physical arrangement. The best way to determine device order is to run the following

command: BOX * DID. This command returns a list of the names and device IDs (which is the number of the

device) for every device in the stack.

1.4 Syntax Conventions

The syntax conventions described in this section apply throughout this manual.

1.4.1 Command-level Syntax Conventions

The following is an example of the command syntax used at the command level:

EP <EPT> <EPN> <BN> <PN> [VALUE]

This example shows known commands/parameters using a monospaced font. In this case, the command is EP, or

End Point, and it can be followed by several parameters, shown in either angle brackets <> or square brackets [],

Autres manuels pour CONVERGE PRO 2

Table des matières

Manuels Plateforme multiservices populaires d'autres marques

Banner

Banner SureCross DX99 FlexPower Series Manuel utilisateur

VeEX

VeEX eCPRI Manuel utilisateur

Vestil

Vestil FTLP Series Manuel utilisateur

ATD Tools

ATD Tools ATD7341 Instructions d'utilisation

Calix

Calix E7-20 Manuel utilisateur

Vestil

Vestil WP Series Manuel utilisateur

Bosch

Bosch XDK Manuel utilisateur

TEUPEN

TEUPEN LEO 23 GT Manuel utilisateur

Juniper

Juniper NFX350 Manuel utilisateur

Vestil

Vestil WP Series Fiche technique

Cisco

Cisco ONS 15454 Series Manuel

Airo

Airo XS Series Manuel utilisateur

Siemens

Siemens RUGGEDCOM RX1400 Manuel utilisateur

Siemens

Siemens SIMATIC NET RUGGEDCOM MX5000 Manuel utilisateur

PASCO

PASCO ME-6834 Manuel utilisateur

Parker

Parker P2M Node 24 DO Manuel utilisateur

Cisco

Cisco ONS 15454 Series Manuel utilisateur

Infinera

Infinera ATN Instructions d'utilisation et d'installation