ClearOne CONVERGE PRO 2 Series Reference Manual
  1. Manuals
  2. Brands
  3. ClearOne Manuals
  4. Multi-service Platforms
  5. CONVERGE PRO 2
  6. Reference manual

ClearOne CONVERGE PRO 2 Series Reference Manual

Hide thumbs Also See for CONVERGE PRO 2 Series:
Table of Contents

Advertisement

Quick Links

Reference Manual
CONVERGE PRO 2 Serial Commands
Supported Products:
CONVERGE Pro 2 Devices
DOC-0293-001 v.1.9 October 2020

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the CONVERGE PRO 2 Series and is the answer not in the manual?

Questions and answers

Related Manuals for ClearOne CONVERGE PRO 2 Series

Summary of Contents for ClearOne CONVERGE PRO 2 Series

  • Page 1 Reference Manual CONVERGE PRO 2 Serial Commands Supported Products: CONVERGE Pro 2 Devices DOC-0293-001 v.1.9 October 2020...

  • Page 2: Notices

    ClearOne Part Number: DOC-0293-001 (Revision 1.9) October 2020 © 2016-2020 ClearOne Inc. - All rights reserved. Information in this document is subject to change without notice. Other product names may be registered trademarks of their respective owners who do not necessarily endorse ClearOne or...

  • Page 3: Table Of Contents

    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 ....................
  • Page 4 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) ......................

  • Page 5: Box-Serial_Port

    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) ....................
  • Page 6 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 ........................
  • Page 7 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...

  • Page 8: Concepts

    CONVERGE Pro 2 Serial Commands Reference Manual 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.

  • Page 9: End Points

    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”.

  • Page 10: End Point Numbering

    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.

  • Page 11: Parameter-Level Syntax Conventions

    CONVERGE Pro 2 Serial Commands Reference Manual with the parameter names italicized. Important: The command, any parameters, and any values must all be separated by a space. Note the following: • Angle brackets <> indicate a required parameter; square brackets [] indicate an optional parameter. •...

  • Page 12: Input/Output

    CONVERGE Pro 2 Serial Commands Reference Manual GAIN_FINE (1) Fine gain. Default decibel range of -65 to 20 unless adjusted with MAX_GAIN or MIN_GAIN, adjust in increments of 0.5 Note: More information about gain or fine gain is available at the beginning of the EP section.

  • Page 13: Output

    CONVERGE Pro 2 Serial Commands Reference Manual 1.5.2 Output A box can also send output to you via the serial port connection. When you send commands to a box, the box sends you return information as output. In the first example above, where you sent a command to mute microphone channel 1, the box would return the following: EP MIC 101 LEVEL MUTE 1 Notice that the output command is the same as the input command.

  • Page 14: Text Vs. Numerical Parameters

    CONVERGE Pro 2 Serial Commands Reference Manual 1.6 Text vs. Numerical Parameters Most parameters (unless noted otherwise) can be expressed as either text or as numbers. As a convention, this manual uses text for all parameter examples, such as the following, for setting the coarse gain on a microphone: EP MIC 101 LEVEL GAIN_COARSE 21 The same command can be entered using numerical values in place of text parameters, however:...

  • Page 15: Meaning Of Rwc

    Using labels and groups makes it far easier to remember and refer to end point channels. Note the following: • Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names (a reference to a user-defined group of end points) and Label names (a reference to a single end point).

  • Page 16: Volume Up Settings

    CONVERGE Pro 2 Serial Commands Reference Manual 1.9.1 Volume Up Settings Setting Example Command Explanation Press (used Ramps up OUTPUT channel 101 (the first output RAMP OUTPUT 101 20 10 when you press channel on device 1 of the stack) up to 20 dB in the Volume Up increments of 10 dB.

  • Page 17: Slider Position Settings

    CONVERGE Pro 2 Serial Commands Reference Manual 1.9.3 Slider Position Settings Setting Example Command Explanation Query Command Sends a query to the device to know the gain level RAMP OUTPUT LEVEL GAIN of channel OUTPUT 101. Replace OUTPUT 101 with the channel type and end point number of your choice or a channel or group label.

  • Page 18: Chapter 2 - Reference

    CONVERGE Pro 2 Serial Commands Reference Manual Query Sends a query to the device to know the mute state EP MIC 101 LEVEL MUTE Command for MIC channel 101. Replace “MIC 101” with the channel type and end point number of your choice or a channel or group label.

  • Page 19: Stack-System (1)

    CITY (3) COMPANY (4) BUILDING (5) ROOM (6) REGION (7) SITE_NAME (8) SMTP (8) EMAIL_GROUP (1) EMAIL_ROUTING (2) ENABLE (3) ADMIN (9) USERNAME (1) clearone PASSWORD (2) converge SNMP_MGR (10) IP (1) PORT 10000 READ_PASSWORD read_me WRITE_PASSWORD write_me 2.1.3 Stack-SYSTEM (1) Function Turns on the safety mute feature, which mutes all outputs.

  • Page 20: Stack-Admin (9)

    • Username: no spaces, minimum of 2 characters, and cannot be ‘root’ • Password: no spaces, no commas, minimum of 4 characters Input Description Value Default USERNAME (1) Username A text string clearone PASSWORD (2) Password A text string converge Example Name Function Example Command...

  • Page 21: Stack-Clock (5)

    CONVERGE Pro 2 Serial Commands Reference Manual PASSWORD Sets a password for a stack STACK ADMIN PASSWORD MyPassword Output Output USERNAME STACK ADMIN USERNAME MyUsername PASSWORD STACK ADMIN PASSWORD MyPassword 2.1.5 Stack-CLOCK (5) Function Changes some clock settings for a stack. Note: To change the date and time, use the CLOCK command.

  • Page 22: Stack-Location

    CONVERGE Pro 2 Serial Commands Reference Manual TIME_ZONE_NAME The name for A text string a time zone, as chosen by a user. * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction.
  • Page 23 CONVERGE Pro 2 Serial Commands Reference Manual Function Changes the location settings of a stack. Note: Using this serial command is the only way to change the stack location settings. There is no corresponding settings in the CONSOLE AI application. Syntax STACK LOCATION <PN>...

  • Page 24: Stack-Smtp (8)

    CONVERGE Pro 2 Serial Commands Reference Manual Name Function Example Command COUNTRY Sets the country for a stack location STACK LOCATION COUNTRY USA STATE Sets the state for a stack location STACK LOCATION STATE COLORADO CITY Sets the city for a stack location STACK LOCATION CITY DENVER COMPANY Sets the company for a stack location...

  • Page 25: Stack-Snmp_Mgr

    CONVERGE Pro 2 Serial Commands Reference Manual Description Values Default RWC* EMAIL_GROUP (1) The name of the email An email address. address to which Email address can have up to notifications should be sent. 128 characters and must be in the format of an email address (such as: recipient@server.com).

  • Page 26: Box

    CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default RWC* IP (1) The SNMP server address. An IP address. PORT (2) The port to use to connect to A numerical value between the SNMP server. 1 and 1000. Leave blank to retrieve current value.

  • Page 27: Box Function, Syntax, Parameters

    CONVERGE Pro 2 Serial Commands Reference Manual 2.2.1 Box Function, Syntax, Parameters Function Gets information about and configures a particular CONVERGE Pro 2 box. Syntax BOX <BOXNAME> <BN> <PN> [VALUE] Parameters Parameter Description BOXNAME Use this argument to indicate the name of the CONVERGE Pro 2 box, or unit, you’re referencing.
  • Page 28 CONVERGE Pro 2 Serial Commands Reference Manual VALUE Default RWC* Gran UNIT (1) IP (1) MODEL (2) SN (3) MAC (4) DID (5) NAME (6) LINK_STATUS (8) VOIP_MODE (9) FTP_ENABLE 0 = Enable (Default) 1 = Front panel USB only TELNET_ENABLE 0 = Disable 1 = Enable...
  • Page 29 CONVERGE Pro 2 Serial Commands Reference Manual ETHERNET_PORT (6) DHCP_ENABLE (1) STATIC_IP (2) STATIC_SUBNET (3) STATIC_GATEWAY (4) STATIC_DNS (5) STATIC_ALT_DNS (6) STATIC_DOMAIN_NAME UPDATE (8) MAC (9) IP (10) LINK_STATUS (11) SUBNET (12) GATEWAY (13) DNS (14) ALT_DNS (15) DOMAIN_NAME (16) DANTE (7) MAC_ADDRESS1 (1) MAC_ADDRESS (2)
  • Page 30 CONVERGE Pro 2 Serial Commands Reference Manual VLAN_VOIP (9) ID (2) 4094 PRIORITY (3) STATIC_IP (4) STATIC_SUBNET (5) STATIC_GATEWAY (6) STATIC_DNS (7) STATIC_ALT_DNS (8) DHCP_ENABLE (9) IP (10) LINK_STATUS (11) SUBNET (12) GATEWAY (13) DNS (14) ALT_DNS (15) VOIP_CFG (10) ENABLE (1) URL (2) USERNAME (3)

  • Page 31: Box-Dante (7)

    CONVERGE Pro 2 Serial Commands Reference Manual VALUE Default RWC* Gran VOIP_PORT (15) UPDATE (8) MAC (9) IP (10) LINK_STATUS (11) SUBNET (12) GATEWAY (13) DNS (14) ALT_DNS (15) DOMAIN_NAME (16) VOIP_CONNECT (16) PORT (1) VLAN (2) UPDATE (3) IP (4) LINK_STATUS (5) USB_PORT (17) MAC (1)
  • Page 32 CONVERGE Pro 2 Serial Commands Reference Manual IP_ADDRESS1 (3) Use to retrieve the primary IP address Read only of the port. IP_ADDRESS2 (4) Use to retrieve the secondary IP Read only address of the port. LINK_STATUS1 (5) Use to retrieve the primary link status Read only of the port.

  • Page 33: Box-Ethernet_Port

    CONVERGE Pro 2 Serial Commands Reference Manual Output Output MAC_ADDRESS1 BOX BOX3 DANTE MAC_ADDRESS1 00:14:22:01:23:45 MAC_ADDRESS2 BOX Boardroom_Box DANTE MAC_ADDRESS2 00:14:22:01:23:46 IP_ADDRESS1 BOX BOX4 DANTE IP_ADDRESS1 192.168.0.100 IP_ADDRESS2 BOX BOX4 DANTE IP_ADDRESS2 192.168.0.101 LINK_STATUS1 BOX CP2_R2D2 DANTE LINK_STATUS1 LINK_STATUS2 BOX CP2_C3PO DANTE LINK_STATUS2 BDNAME1 BOX BOX_4 DANTE BDNAME1 DANTE_4 CHANNELS...
  • Page 34 CONVERGE Pro 2 Serial Commands Reference Manual STATIC_IP (2) If DHCP is turned off, use to set a An IP address. static IP address for a box. Leave blank to retrieve the current Note: If DHCP is enabled, this value. parameter is ignored.
  • Page 35 CONVERGE Pro 2 Serial Commands Reference Manual GATEWAY (13) Use to retrieve the gateway Read only. Returns address of the Ethernet port. an IP address. DNS (14) Use to retrieve the primary DNS Read only. Returns server address of the Ethernet an IP address.
  • Page 36 CONVERGE Pro 2 Serial Commands Reference Manual LINK_STATUS Retrieve the link status for the BOX MyBox ETHERNET_PORT LINK_STATUS Ethernet port of a device called MyBox SUBNET Retrieve the subnet address for BOX MyBox ETHERNET_PORT SUBNET the Ethernet port of a device called MyBox GATEWAY Retrieve the gateway address for...

  • Page 37: Box-Locate (18)

    CONVERGE Pro 2 Serial Commands Reference Manual GATEWAY BOX MyBox ETHERNET_PORT GATEWAY 192.128.16.1 BOX MyBox ETHERNET_PORT DNS 212.212.212.212 ALT_DNS BOX MyBox ETHERNET_PORT ALT_DNS 212.212.212.213 DOMAIN_NAME BOX MyBox ETHERNET_PORT DOMAIN_NAME MyDomain.com 2.2.5 Box-LOCATE (18) Function Locates a CP2 device by causing Locate LED on the front panel to blink Syntax BOX <BOXNAME>...

  • Page 38: Box-Plink (19)

    Note: The long-distance P-link feature lets you place P-link devices up to 650 feet apart. For more details see the Long Distance P-link application tech note in the Resource Library on the ClearOne website. Syntax BOX <BOXNAME> PLINK <PN> [VALUE]...
  • Page 39 CONVERGE Pro 2 Serial Commands Reference Manual 2.2.8 Box-SERIAL_PORT (5) Function Retrieves or changes the serial port settings for a particular CONVERGE Pro 2 box Syntax BOX <BOXNAME> SERIAL_PORT <PN> [VALUE] Input Description Value Default RWC* BAUD_RATE (1) Baud rate Possible value: 9600, 19200, 57600 38400, 57600, 115200...

  • Page 40: Box-Unit (1)

    CONVERGE Pro 2 Serial Commands Reference Manual STOP_BITS BOX MYBOX SERIAL_PORT STOP_BITS 1 PARITY BOX MYBOX SERIAL_PORT PARITY 0 FLOW_CONTROL BOX MYBOX SERIAL_PORT FLOW_CONTROL 0 ECHO BOX MYBOX SERIAL_PORT ECHO 0 2.2.9 Box-UNIT (1) Function Retrieves information about a particular box and causes the Locate LED light to blink; makes it easier to locate a particular box.
  • Page 41 1 = FTP via Front USB port ONLY. control) on the network and frontside USB connectors WARNING! This prevents ClearOne CONVERGENCE from operating with this device. In addition, Console AI can be connected only via the unit’s frontside USB connector.
  • Page 42 CONVERGE Pro 2 Serial Commands Reference Manual SSH_ENABLE Turns on the unit’s SSH service BOX MyBox SSH_ENABLE 1 Output Output BOX MYBOX UNIT IP 192.168.1.100 MODEL BOX MYBOX UNIT MODEL CONVERGE Pro 2 128T BOX MYBOX UNIT SN ENG1-0C56-D1 BOX MYBOX UNIT MAC 00:06:24:0C:56:D1 BOX MYBOX UNIT DID 1 NAME BOX MYBOX UNIT NAME MYBOX...
  • Page 43 CONVERGE Pro 2 Serial Commands Reference Manual LINK_STATUS (3) Use to retrieve the link status of Read only. Returns the the USB port. following values: 0 = not connected 1 = connected Examples Name Function Command Retrieve the MAC address for BOX MyBox USB_PORT MAC the USB port of a device called MyBox...
  • Page 44 CONVERGE Pro 2 Serial Commands Reference Manual STATIC_SUBNET (5) The VLAN subnet mask. A subnet mask Note: If DHCP is enabled, this parameter is ignored. STATIC_GATEWAY (6) The VLAN gateway IP address. An IP address Note: If DHCP is enabled, this parameter is ignored.
  • Page 45 CONVERGE Pro 2 Serial Commands Reference Manual PRIORITY Sets the VLAN traffic priority to 5 for BOX BOX1 VLAN_VOIP PRIORITY 5 a device named BOX1 STATIC_IP Sets the VLAN static IP address for BOX BOX1 VLAN_VOIP STATIC_IP a device named BOX1 218.174.3.12 STATIC_SUBNET Sets the VLAN subnet mask for a...
  • Page 46 CONVERGE Pro 2 Serial Commands Reference Manual STATIC_GATEWAY BOX BOX1 VLAN_VOIP STATIC_GATEWAY 218.174.3.1 STATIC_DNS BOX BOX1 VLAN_VOIP STATIC_DNS 218.174.3.100 ALT_DNS_IP BOX BOX1 VLAN_VOIP STATIC_ALT_DNS 218.174.3.101 DHCP_ENABLE BOX BOX1 VLAN_VOIP DHCP_ENABLE 1 BOX MyBox VLAN_VOIP IP 192.128.16.10 LINK_STATUS BOX MyBox VLAN_VOIP LINK_STATUS 1 SUBNET BOX MyBox VLAN_VOIP SUBNET 255.255.255.0 GATEWAY...
  • Page 47 CONVERGE Pro 2 Serial Commands Reference Manual URL (2) The address (HTTP or FTP site) A URL Examples: http:// mysite. where the VOIP configuration mycompany.com ftp:// ftp. files (VoipSettingsCFG.txt, mycompany.com c1_media.txt, and C1_dialplan. 256 characters maximum. Leave txt) are located. blank to retrieve current value Note: VOIP configuration files are generated by the...

  • Page 48: Box-Voip_Connect

    CONVERGE Pro 2 Serial Commands Reference Manual 2.2.13 Box-VOIP_CONNECT (16) Function Specify the VOIP connection settings for a device Syntax BOX <BOXNAME> VOIP_CONNECT <PN> [VALUE] Input Description Value Default PORT (1) Use to specify whether you want to use the 0 = Disable VoIP port or the Ethernet port on the rear 1 = Enable...

  • Page 49: Box-Voip_Port

    CONVERGE Pro 2 Serial Commands Reference Manual LINK_STATUS Retrieves the link status of whichever BOX CP2_6 VOIP_CONNECT LINK_STATUS interface (Ethernet port, VoIP port, or VLAN) is being used to route VoIP traffic on the device named CP2_6 Output Output PORT BOX CP2_6 VOIP_CONNECT PORT 1 VLAN BOX CP2_6 VOIP_CONNECT VLAN 1...
  • Page 50 CONVERGE Pro 2 Serial Commands Reference Manual STATIC_SUBNET (3) Use to set the subnet mask for the VoIP A subnet mask. port. Leave blank to retrieve the current value. Note: If DHCP is enabled, this parameter is ignored. STATIC_GATEWAY (4) Use to set the gateway address for the An IP address.
  • Page 51 CONVERGE Pro 2 Serial Commands Reference Manual introduction. Examples Name Function Example Command DHCP_ENABLE Turns off DHCP for the BOX MyBox VOIP_PORT DHCP_ENABLE 0 VoIP port of a device called MyBox. STATIC_IP Sets a static IP address for BOX MyBox VOIP_PORT STATIC_IP 192.128.16.12 the VoIP port of a device called MyBox STATIC_SUBNET...

  • Page 52: Box-Temp

    CONVERGE Pro 2 Serial Commands Reference Manual Output Output DHCP_ENABLE BOX MyBox VOIP_PORT DHCP_ENABLE 0 STATIC_IP BOX MyBox VOIP_PORT STATIC_IP 192.128.16.12 STATIC_SUBNET BOX MyBox VOIP_PORT SUBNET_MASK 255.255.255.0 STATIC_GATEWAY BOX MyBox VOIP_PORT GATEWAY_IP 192.128.16.1 STATIC_DNS BOX MyBox VOIP_PORT DNS_IP 212.212.212.212 STATIC_ALT_DNS BOX MyBox VOIP_PORT ALT_DNS_IP 212.212.212.213 DOMAIN_NAME BOX MyBox VOIP_PORT DOMAIN_NAME MYDOMAIN.COM...

  • Page 53: Box-Fan

    CONVERGE Pro 2 Serial Commands Reference Manual REMOTE (2) Internal temperature sensor near the unit’s Returns the current power supply temperature in Celsius Examples Name Function Example Command LOCAL Read the unit’s internal temperature in Celsius BOX MyBox TEMP LOCAL REMOTE Read the unit’s internal temperature in Celsius BOX MyBox TEMP REMOTE...

  • Page 54: Room

    CONVERGE Pro 2 Serial Commands Reference Manual Output Output SPEED BOX MyBox FAN SPEED 1 2.3 ROOM 2.3.1 ROOM Function, Syntax, Parameters Function Creates custom partition configurations for rooms that have dividers, and can therefore be partitioned in various ways, select ROOM configurations, and turn on a testing mode (GPIO override).

  • Page 55: Room-Divider Polarity (12)

    CONVERGE Pro 2 Serial Commands Reference Manual Divider Polarity (12) Divider Number Polarity Divider State (13) State Value 2.3.3 ROOM-Divider Polarity (12) Function Specifies the GPIO polarity (high or low) that corresponds to dividers being open. Syntax ROOM <ROOM_NO> 12 [DIVIDER_NO] [POLARITY] Input Parameters Description...
  • Page 56 CONVERGE Pro 2 Serial Commands Reference Manual STATE_VALUE A divider state value. A value made of ones (1), zeros (0) and periods (.) that represents the physical divider state of a room. See the State_Value section below for more information. Examples Name Function...

  • Page 57: Room-Individual Divider State (11)

    CONVERGE Pro 2 Serial Commands Reference Manual 2.3.5 Room-Individual Divider State (11) Function Indicates that an individual divider in a room is opened or closed Syntax ROOM <ROOM_NO> 11 [DIVIDER_NO] [STATE_VALUE] Note: Alternatively, you can use the ROOM Divider State command to indicate the open/closed status of all the dividers in a room (see ROOM-Divider State (13) for more information).

  • Page 58: Room-Select (7)

    CONVERGE Pro 2 Serial Commands Reference Manual Example Name Function Example Command MODE_TYPE Turns on GPIO override for ROOM 1 1 1 ROOM 1 Output Arg1 Output MODE_TYPE ROOM 1 1 1 2.3.7 ROOM-Select (7) Function Selects the preset that will run when a particular sub-room space becomes active Syntax ROOM <ROOM_NO>...
  • Page 59 CONVERGE Pro 2 Serial Commands Reference Manual Example Name Function Example Command MODE_TYPE Selects a preset file for use with ROOM 1 7 Part_A_B_C Part_A_B_C_Preset_1 the ABC sub-room space Output The following is sample output for Example 1: Arg1 Output MODE_TYPE ROOM 1 7 Part_A_B_C Part_A_B_C_Preset_1 1 Back to Table of Contents...
  • Page 60 2 would add 2 to the current fine gain value, rather than setting the value to 2dB. Note: This switch applies only when setting gain or fine gain values. Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers.

  • Page 61: Ep Command Table

    CONVERGE Pro 2 Serial Commands Reference Manual 2.4.1 EP Command Table This table shows all the possible parameter combinations for the EP command. 2.4.1.1 Parameter Table Value Default Gran MIC (1) LEVEL (1) GAIN_FINE (1) MUTE (2) PHAN_PWR (3) GAIN_COARSE (4) MAX_GAIN (7) MIN_GAIN (8) DIG_SRC (9)
  • Page 62 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran MIC (1) FILTER_2 (8) TYPE (1) FCY (2) 20000 0.01 1000 GAIN (3) 0.01 BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_3 (9) TYPE (1) FCY (2) 20000 0.01 1000 GAIN (3) 0.01 BW (6)
  • Page 63 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran TELCO_RX (3) LEVEL (1) GAIN (1) MUTE (2) DIAL_TONE_LEVEL (3) BOOST_LEVEL (4) DTMF_LEVEL (5) AUDIBLE_CONNECT_ LEVEL (6) MAX_GAIN (10) MIN_GAIN (11) LABEL (11) SETTINGS (2) AUTO_ANSWER_RINGS AUTO_DISCONNECT_ MODE (2) RING_TYPE (3) ADAPT (4) HOOK_FLASH_DURATION 2000...
  • Page 64 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran HOOK_LEVEL (8) RING_CAD_CUST (9) RING_ON_TIME (10) RING_OFF_TIME (11) COUNTRY_CODE (12) LAST_DIALED_DIGITS (13) LOCAL_NUMBER (14) KEY (3) KEY_CALL (1) KEY_HOOK_FLASH (2) KEY_REDIAL (4) KEY_HOOK (5) KEY_DIGIT_PRESSED (6) KEY_DIGIT_RELEASED (7) NOTIFICATION (4) INCOMING_CALL (1) CALLER_ID (2) CALL_DURATION (3)
  • Page 65 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran VOIP_RX (5) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) VOIP_TX (6) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) OUTPUT (7) LEVEL (1) GAIN (1) MUTE (2)
  • Page 66 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran OUTPUT (7) FILTER_2 (3) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01 SLOPE (4) SFT (5) BW (6) 0.05 0.01 0.33...
  • Page 67 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran OUTPUT (7) GRAPHICEQ (6) ENABLE (1) GAIN_1 (2) GAIN_2 (3) GAIN_3 (4) GAIN_4 (5) GAIN_5 (6) GAIN_6 (7) GAIN_7 (8) GAIN_8 (9) GAIN_9 (10) GAIN_10 (11) LIMITER (7) ENABLE (1) THRESHOLD (2) DELAY (8) ENABLE (1)
  • Page 68 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran SPEAKER (8) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (6) MIN_GAIN (7) FILTER_1 (2) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01...
  • Page 69 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01 SLOPE (4) SFT (5) BW (6) 0.05 0.01 0.33 ENABLE (7) GRAPHICEQ (6) ENABLE (1) GAIN_1 (2) GAIN_2 (3) GAIN_3 (4) GAIN_4 (5) GAIN_5 (6) GAIN_6 (7)
  • Page 70 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran LEVEL (1) MAX_GAIN (6) MIN_GAIN (7) DELAY (2) ENABLE (1) VALUE (2) COMPRESSOR (3) ENABLE (1) GROUP (2) POST_GAIN (3) THRESHOLD (4) ATTACK (5) RATIO (6) RELEASE (7) 2000 DELAY_ ENABLE (8) DELAY (9) FILTER_1 (4) TYPE (1)
  • Page 71 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran FILTER_3 (6) SLOPE (4) SFT (5) BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_4 (7) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3)
  • Page 72 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran FILTER_7 (10) SFT (5) BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_8 (11) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01 SLOPE (4)
  • Page 73 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran FILTER_11 (14) BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_12 (15) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01 SLOPE (4) SFT (5)
  • Page 74 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran FILTER_15 (18) ENABLE (7) FBE (37) ENABLE (7) FADER (10) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (6) MIN_GAIN (7) LABEL (8) Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 75 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran BFM (13) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) NC (2) ENABLE (1) DEPTH (2) ALC (3) ENABLE (1) NLP (4) SETTING (1) AEC (5) ENABLE (1) REFGAIN (6) GAIN (1)
  • Page 76 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_2 (11) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01 SLOPE (4) SFT (5) BW (6) 0.05...
  • Page 77 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran USB_TX (15) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) UA (20) KEY (1) KEY_CALL (1) KEY_REJECT (2) KEY_HOLD (3) KEY_TRANSFER (4) KEY_BLIND_TRANSFER KEY_CONFERENCE (6) KEY_DIGIT_ PRESSED (7) KEY_DIGIT_ RELEASED KEY_REDIAL (9) KEY_PARTY (10)
  • Page 78 INDICATION (2) ERROR (4) REG_FAILED (5) REG_SUCCEED (6) UNREG_SUCCEED (7) MAX_CALLS_PER_UA (5) SETTINGS (6) UA_ENABLE (1) USERNAME (2) admin PASSWORD (3) clearone SEC_USERNAME (4) admin SEC_PASSWORD (5) clearone DISPLAY_NAME (6) admin ACTIVE_RINGTONE (7) AUTO_ANSWER (9) GPIO (21) PIN (1) MODE (1)
  • Page 79 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran SRMIC (24) LEVEL (1) GAIN_FINE (1) MUTE (2) PHAN_PWR (3) GAIN_COARSE (4) MAX_GAIN (7) MIN_GAIN (8) DIG_SRC (9) LABEL (10) AGC (4) GAIN (1) TARGET_LEVEL (2) RESPONSE_TIME (3) 10000 2000 THRESHOLD (4) AGC_ALC (5) MODE (1)
  • Page 80 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran FILTER_1 (7) TYPE (1) FCY (2) (except CD Horn) 20000 0.01 1000 FCY (2) (CD Horn) 5000 0.01 1000 GAIN (3) 0.01 BW (4) 0.05 0.01 0.33 ENABLE (5) FILTER_2 (8) TYPE (1) FCY (2) (except CD Horn) 20000...
  • Page 81 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran D20MIC (28) LEVEL (1) GAIN (1) MUTE (2) MODE (7) LABEL (8) GATING (4) GROUP (1) NONE (2) MODE (3) CHAIRMAN (4) ADAPT_AMB (6) AMB_LEVEL (7) OFF_ATTEN (8) GATE_RATIO (9) HOLD_TIME (10) 0.01 DECAY_RATE (11)
  • Page 82 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran USBE_RX (29) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) USBE_TX (30) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) EXP_D20MIC (33) LEVEL (1) LED (1) LABEL (2)
  • Page 83 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran TEMP (4) RECEIVER (5) OLED_DISPLAY_NAME (2) OLED_TIMER (3) MIXED_OUTPUT_MUTE (5) 0 MIXED_OUTPUT_LEVEL -100 SLOT1 (6) NAME (1) RF_CHAN_NUM (2) TOUR_MODE (3) KEY (4) OUTPUT_MUTE (5) OUTPUT_LEVEL (6) -100 SLOT2 (7) NAME (1) RF_CHAN_NUM (2) TOUR_MODE (3)
  • Page 84 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran ECHO (6) UNIT (3) MODEL (1) SN (2) LOCATE (4) MODE (1) TIMEOUT (2) VERSION (5) APP (1) FPGA (2) EXP_GPIO (35) LEVEL (1) LED (1) SERIAL_PORT (2) BAUD_RATE (1) 9600 115200 57600...
  • Page 85 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran EXP_BT (44) LEVEL (1) LED (1) LABEL (2) UNIT (2) SN (2) LOCATE (3) MODE (1) TIMEOUT (2) VERSION (44) MDO (1) EXP (5) SN (1) DISABLE (9) Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 86 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran CTBFM (45) LEVEL (1) GAIN (1) MUTE (2) MAX_GAIN (5) MIN_GAIN (6) LABEL (7) NC (2) ENABLE (1) DEPTH (2) ALC (3) ENABLE (1) NLP (4) SETTING (1) AEC (5) ENABLE (1) REFGAIN (6) GAIN (1)
  • Page 87 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran CTBFM (45) FILTER_1 (10) TYPE (1) FCY (2) 20000 0.01 1000 GAIN (3) 0.01 BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_2 (11) TYPE (1) FCY (2) 20000 0.01 1000 GAIN (3) 0.01 BW (6)
  • Page 88 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran CTBFM (45) GATING (14) DECAY_RATE (11) UNIT (16) MODEL (1) SN (2) SWITCH (4) POE_SWITCH_ERROR (5) POE_INJECTOR_ERROR POE_INJECTOR_POWER LOCATE MODE (1) TIMEOUT (2) CTBFM_SPKR LEVEL (1) GAIN (1) (47) MUTE (2) POLARITY (3) MAX_GAIN (7) MIN_GAIN (8)
  • Page 89 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran CTBFM_SPKR FILTER_3 (4) TYPE (1) (47) FCY (2) 20000 0.01 1000 GAIN (3) 0.01 SLOPE (4) SFT (5) BW (6) 0.05 0.01 0.33 ENABLE (7) FILTER_4 (13) TYPE (1) FCY (2) 20000 0.01 1000...
  • Page 90 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran BMA360 (48) BEAMS (7) PATTERN (1) 10000 SIZE (2) HEIGHT (3) 0.01 ROTATION (4) -180 HIGH_PASS (5) LOW_PASS (6) HUM_FILTER (7) OFF_ATTEN (8) -100.0 -12.0 -100.0 SENSITIVITY (9) HOLD_TIME (10) 2000 BF (8) ZONE_1 (2)
  • Page 91 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran BMA360 (48) LED_CONTROL MUTE_COLOR (1) UNMUTE_COLOR (2) MUTE_BRIGHTNESS (3) UNMUTE_BRIGHTNESS MUTE_BLINK (5) UNMUTE_BLINK (6) FILTER_1 (12) TYPE (1) FCY (2) 20000 0.01 1000 GAIN (3) 0.01 SLOPE (4) SFT (5) BW (6) 0.05 0.01...
  • Page 92 CONVERGE Pro 2 Serial Commands Reference Manual Value Default Gran BMA360 (48) GATING (16) GROUP (1) NONE (2) MODE (3) CHAIRMAN (4) PA_ADAPT (5) ADAPT_AMB (6) AMB_LEVEL (7) -80.0 -30.0 OFF_ATTEN (8) 60.0 GATE_RATIO (9) 50.0 HOLD_TIME (10) DECAY_RATE (11) UNIT (18) MODEL (1) SN (2)

  • Page 93: Bfm

    Manages the Acoustic Echo Cancellation of a ClearOne Beamforming Microphone Array 2 Syntax EP BFM <EPN> AEC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 94 Configures the Automatic Level Control settings of a ClearOne Beamforming Microphone Syntax EP BFM <EPN> ALC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 95 Manages the general settings of a ClearOne Beamforming Microphone Array 2 Syntax EP BFM <EPN> BF <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 96 CONVERGE Pro 2 Serial Commands Reference Manual ZONE_3 (7) Enable zone 3 beam. 0 = Disable 1 = Enable 2 = Toggle Current State Leave blank to retrieve current value ZONE_4 (8) Enable zone 4 beam 0 = Disable 1 = Enable 2 = Toggle Current State Leave blank to retrieve current value ZONE_5 (9)
  • Page 97 Configures the Filter_1 settings of a ClearOne Beamforming Microphone Array 2 channel Syntax EP BFM <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 98 CONVERGE Pro 2 Serial Commands Reference Manual FCY (2) Sets the center frequency (in 20 to 20000 in increments of 0.01 1000 Hz). Leave blank to retrieve current value Note: Applies to all filter types. GAIN (3) Sets the gain value. -15 to 15 in increments of 0.01 Leave blank to retrieve current value Note: Applies only to type...
  • Page 99 Syntax EP BFM <EPN> GATING <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Channel Labels and Groups.
  • Page 100 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default GROUP (1) GROUP enables assignment 1 to 8 of channels with same Leave blank to retrieve current value settings to up to eight (8) gating groups. Note: The preferred way to assign mics to a group is to use the GATEGROUP command.
  • Page 101 CONVERGE Pro 2 Serial Commands Reference Manual AMB_LEVEL Ambient Level lets you -80dB to 0dB, in increments of 0.5 manually specify a fixed Leave blank to retrieve current value ambient level. OFF_ATTEN Off Attenuation allows you -60dB to 0dB, in increments of 0.5. to set the amount of level Leave blank to retrieve current value reduction applied to a...
  • Page 102 CONVERGE Pro 2 Serial Commands Reference Manual ADAPT_AMB Enables ambient adapt on a BFM channel EP BFM1 GATING ADAPT_AMB 1 with the label BFM1 OFF_ATTEN Sets the amount of level reduction applied EP BFM1 GATING OFF_ATTEN -52.5 to a BFM channel with the label BFM1, when gated off GATE_RATIO Sets the Gate Ratio on a BFM channel with...
  • Page 103 Changes the level of a ClearOne Beamforming Microphone Array 2 Syntax EP BFM <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 104 Syntax EP BFM <EPN> NC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 105 Array 2. NLP helps eliminate residual echo after acoustic echo cancellation has been applied. Syntax EP BFM <EPN> NLP <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 106: Bma360

    Manages the Acoustic Echo Cancellation of a ClearOne BMA 360 Syntax EP BMA360 <EPN> AEC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 107 Function Selects a pre-defined beam pattern. Please see the current version of CONSOLE AI for possible patterns and their associated index number - this may change over time as ClearOne releases new beam patterns. Syntax EP BMA360 <EPN> BEAMS [beam_index_number] Default value = 1.
  • Page 108 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default PATTERN (1) Set the BMA360 to a 0 to 10000, in increments of 1 predetermined pattern Leave blank to retrieve current value SIZE (2) Set the size of the beam 1 to 12, in increments of 1 pattern Leave blank to retrieve current value...
  • Page 109 CONVERGE Pro 2 Serial Commands Reference Manual OFF_ATTEN (8) Sets the off attenuation -100.0 to -12.0, in increments of 0.5 -100.0 level for the beams Leave blank to retrieve current value SENSITIVITY Sets the sensitivity of the 10 to 2000, in increments of 1 beams Leave blank to retrieve current value HOLD_TIME...
  • Page 110 CONVERGE Pro 2 Serial Commands Reference Manual ZONE_7_MUTE Mutes the zone 7 beam 0 = Normal operation (20) 1 = Mute beam 2 = Toggle state Leave blank to retrieve current value ZONE_8_MUTE Mutes the zone 8 beam 0 = Normal operation (21) 1 = Mute beam 2 = Toggle state...
  • Page 111 EP MyBMA360 BEAMS HOLD_TIME 600 ZONE_3_MUTE EP MyBMA360 BF ZONE_3_MUTE 1 EP-BMA360 (48) BF (7) Function Manages the general settings of a ClearOne BMA 360 Syntax EP BMA360 <EPN> BF <PN> [VALUE] Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 112 CONVERGE Pro 2 Serial Commands Reference Manual Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 113 CONVERGE Pro 2 Serial Commands Reference Manual ZONE_7 (8) Enable zone 7 beam. 0 = Disable 1 = Enable 2 = Toggle current state Leave blank to retrieve current value ZONE_8 (9) Enable zone 8 beam. 0 = Disable 1 = Enable 2 = Toggle current state Leave blank to retrieve current value ZONE_9 (10)
  • Page 114 Configures the Filter_1 settings of a ClearOne BMA 360 Syntax EP BMA360 <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 115 CONVERGE Pro 2 Serial Commands Reference Manual BW (6) Set the difference between the 0.05 to 5 in increments of 0.01 0.33 upper and lower points of a Leave blank to retrieve current value filter’s audio pass band. Note: Applies only to type 6, parametric equalizer and type 11, notch.
  • Page 116 Syntax EP BMA360 <EPN> GATING <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Channel Labels and Groups.
  • Page 117 CONVERGE Pro 2 Serial Commands Reference Manual MODE (3) MODE allows you to configure group 1 = Auto settings. 2 = Manual On 3 = Manual Off CHAIRMAN (4) Chairman override provides gating 0 = Disable priority for selected channels over any 1 = Enable other channel within the same group.
  • Page 118 CONVERGE Pro 2 Serial Commands Reference Manual DECAY_RATE Decay Rate allows you to determine 1 = Slow (12dB/s) (11) how fast a channel gates off after the 2 = Medium (25dB/s) Hold Time expires. 3 = Fast (50dB/s) Leave blank to retrieve current value Examples Name...
  • Page 119 Manages how the LED light functions on a ClearOne BMA 360 Syntax EP BMA360 <EPN> LED_CONTROL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Channel Labels and Groups.
  • Page 120 CONVERGE Pro 2 Serial Commands Reference Manual UNMUTE_COLOR (2) Use to specify the color of the 1 = Red LED light on the unit when the 2 = Orange device is unmuted. 3 = Yellow 4 = Green 5 = Blue 6 = Indigo 7 = Violet 8 = White...
  • Page 121 Changes the level of a ClearOne BMA 360 Syntax EP BMA360 <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 122 CONVERGE Pro 2 Serial Commands Reference Manual MUTE (2) Mute. 0 = Unmute 1 to mute 2 to toggle current state Leave blank to retrieve current value MAX_GAIN (5) Maximum gain. This controls how -65 to 20, in increments of 0.5 high gain can be set, and also how high ramping can go.
  • Page 123 Locates a BMA 360 device attached to a CP2 Syntax EP BMA360 <EPN> LOCATE <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 124 Syntax EP BMA360 <EPN> NLP <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 125 Syntax EP <EPN> UNIT <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 126: Bma360_Spkr

    Configures the Filter_1 settings of a BMA 360 speaker channel Syntax EP BMA360_SPKR <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 127 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default TYPE (1) Select a filter type Allowable filter types are: 0 = Filter is Off Note: You must send this parameter first, because when you 1= All Pass send this parameter, the rest of the filter settings are set to their default 2 = Low Pass values.
  • Page 128 CONVERGE Pro 2 Serial Commands Reference Manual ENABLE (7) Enable or disable this filter. to disable to enable to toggle current state Leave blank to retrieve current value Examples Name Function Example Command TYPE Selects a low pass filter type for EP CT_Speaker1 FILTER_1 TYPE 1 FILTER_1 on a BMA360_SPKR channel with the label CT_...
  • Page 129 Changes the level of a BMA 360 speaker Syntax EP BMA360_SPKR <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 130 CONVERGE Pro 2 Serial Commands Reference Manual MUTE (2) Mute. 0 = Unmute 1 = Mute 2 = Toggle current state Leave blank to retrieve current value POLARITY Reverse the polarity. 0 to leave polarity as is 1 to reverse polarity 2 = Toggle current state Leave blank to retrieve current value...

  • Page 131: Bte_Rx

    Changes the level of a BTE_RX channel (a receive channel of a Bluetooth expander) Syntax EP BTE_RX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 132: Bte_Tx

    CONVERGE Pro 2 Serial Commands Reference Manual MAX_GAIN (5) Maximum gain. This -65 to 20, in increments of 0.5 controls how high gain Leave blank to retrieve current can be set, and also how high ramping can value MIN_GAIN (6) Minimum gain.
  • Page 133 Changes the level of a BTE_TX channel (a transmit channel of a Bluetooth expander). Syntax EP BTE_TX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 134: Ctbfm

    Manages the Acoustic Echo Cancellation of a ClearOne BMA CT Syntax EP CTBFM <EPN> AEC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 135 Configures the Automatic Level Control settings of a ClearOne CT BMA Syntax EP CTBFM <EPN> ALC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 136 Manages the general settings of a ClearOne CT BMA Syntax EP CTBFM <EPN> BF <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 137 Configures the Filter_1 settings of a ClearOne CT BMA channel Syntax EP CTBFM <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER For more information.
  • Page 138 CONVERGE Pro 2 Serial Commands Reference Manual More information is available in the Channel Labels and Groups. Input Description Value Default TYPE (1) Select a filter type Allowable filter types are: 0 = Filter is OFF Note: You must send this parameter first, because when 1 = All Pass you send this parameter, the...
  • Page 139 Syntax EP CTBFM<EPN> GATING<PN>[VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. Channel Labels and Groups. More information is available in the Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 140 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default GROUP (1) GROUP enables assignment of 1 to 8 channels with same settings to up to Leave blank to retrieve current eight (8) gating groups. value Note: The preferred way to assign mics to a group is to use the GATEGROUP command.
  • Page 141 CONVERGE Pro 2 Serial Commands Reference Manual OFF_ATTEN (8) Off Attenuation allows you to set the -60dB to 0dB, in increments amount of level of 0.5. reduction applied to a channel when it Leave blank to retrieve is gated off. current value GATE_RATIO (9) Gate Ratio allows you to specify how...
  • Page 142 Manages how the LED light functions on a ClearOne CT BMA Syntax EP CTBFM <EPN> LED_CONTROL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Channel Labels and Groups.
  • Page 143 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default MUTE_COLOR (1) Use to specify the color of the 1 = Red LED light on the unit when the 2 = Orange device is muted. 3 = Yellow 4 = Green 5 = Blue 6 = Indigo 7 = Violet...
  • Page 144 CONVERGE Pro 2 Serial Commands Reference Manual UNMUTE_BLINK (6) Use to specify the blink state 0 = disable of the LED light on the unit when the device is unmuted. 1 = enable 2 = toggle current state Leave blank to retrieve current value * The meaning of the entries in this column is available in the Read/Write Modes section...
  • Page 145 Changes the level of a ClearOne BMA CT Syntax EP CTBFM <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 146 Locates a CT BMA device attached to a CP2 Syntax EP CTBFM <EPN> LOCATE <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 147 Syntax EP CTBFM <EPN> NC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 148 Syntax EP CTBFM <EPN> NLP <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 149: Ctbfm_Spkr

    Configures the Filter_1 settings of a CT BMA speaker channel Syntax EP CTBFM_SPKR <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 150 CONVERGE Pro 2 Serial Commands Reference Manual SFT (5) Set the Slope Filter Type 2 = Low 3 = High Note: Applies only to the crossover filter types (8, 9, and 10). BW (6) Set the difference between the upper 0.05 to 5 in increments of 0.01 0.33 and lower points of a filter’s audio...
  • Page 151 Changes the level of a CT BMA speaker Syntax EP CTBFM_SPKR <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 152 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default GAIN (1) Gain. Default decibel range of -65 to 20 unless adjusted with MAX_GAIN or MIN_GAIN, adjust in increments of 0.5 Note: More information about gain or fine gain is available at the beginning of the EP section.

  • Page 153: D20Mic

    Retrieves information about a DIALOG 20 receiver Syntax EP D20MIC <EPN> EXP <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 154 Syntax EP D20MIC <EPN> GATING <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 155 CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default MODE (3) MODE allows you to configure group 1 = Auto settings. 2 = Manual On 3 = Manual Off Leave blank to retrieve current value CHAIRMAN (4) Chairman override provides gating 0 = Disable priority for selected channels over any 1 = Enable...
  • Page 156 CONVERGE Pro 2 Serial Commands Reference Manual Examples Name Function Example Command GROUP Assigns a D20MIC channel with EP D20MicChannel1 GATING GROUP 8 the label D20MicChannel1 = Group 8 NONE Assigns a D20MIC channel with EP D20MicChannel1 GATING NONE 1 the label D20MicChannel1 = the NONE group MODE...
  • Page 157 Changes the level and source of a DIALOG 20 microphone channel Syntax EP D20MIC <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 158 Configures a DIALOG 20 transmitter. Syntax EP D20MIC <EPN> TRANSMITTER <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 159 CONVERGE Pro 2 Serial Commands Reference Manual TYPE (1) Retrieve the transmitter Read only. Possible return type. values: 0=No transmitter synched 1=Belt Pack 2=Handheld 3=T able T op (Boundary) 4=Goose Neck (Podium) CTRL_LOCK_ BODYPACK (2) Specify whether to lock 0=Unlocked the control button on body 1=Locked pack transmitters.
  • Page 160 CONVERGE Pro 2 Serial Commands Reference Manual RF_STANDBY_ MODE (8) Choose whether to enable 0 = unmute RF standby mode. RF 1 = mute Standby Mode turns off the RF output when the 2 = Toggle Current State transmitter is muted. Leave blank to retrieve current value MUTE_MODE (9)
  • Page 161 CONVERGE Pro 2 Serial Commands Reference Manual BUTTON_MODE_PODIUM Use the button for push- EP D20Mic1 TRANSMITTER BUTTON_MODE_ to-talk on a podium mic PODIUM 2 transmitter for a D20MIC channel named D20Mic1 BUTTON_MODE_BOUNDARY Use the button for push- EP D20Mic1 TRANSMITTER BUTTON_MODE_ to-talk on a boundary mic BOUNDARY 1 transmitter for a D20MIC...
  • Page 162 Retrieves information about a DIALOG 20 mic Syntax EP D20MIC <EPN> UNIT <PN> Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 163: Dante_Rx

    Mutes a DANTE_RX channel and retrieve the channel label Syntax EP DANTE_RX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 164: Dante_Tx

    Mutes a DANTE_TX channel and retrieve the channel label Syntax EP DANTE_TX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 165: Exp_Bt

    Retrieves information about a Bluetooth Expander unit Syntax EP EXP_BT <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 166 Reference Manual Syntax EP EXP_BT <EPN> LOCATE <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 167: Exp_D20Mic

    Enables GPIO muting and retrieve the GPIO state for a DIALOG 20 GPIO pin Syntax EP EXP_D20MIC <EPN> GPIO_IN1 <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 168 CONVERGE Pro 2 Serial Commands Reference Manual STATE (2) Retrieves the current GPIO pin Read only state. Return values: 0 = High 1 = Low * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction.
  • Page 169 CONVERGE Pro 2 Serial Commands Reference Manual * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction. Note: More information about gain or fine gain is available at the beginning of the EP section.
  • Page 170 Mutes states via GPIO and retrieve the GPIO state for a DIALOG 20 GPIO pin Syntax EP EXP_D20MIC <EPN> GPIO_OUT2 <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 171 Changes the level and source of a DIALOG 20 mic channel Syntax EP EXP_D20MIC <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 172 Locates a DIALOG 20 receiver attached to a CP2 Syntax EP EXP_D20MIC <EPN> LOCATE <PN> [VALUE] Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. 1.8 Channel Labels and Groups.
  • Page 173 Configures DIALOG 20 receiver settings Syntax EP EXP_D20MIC <EPN> RECEIVER <PN> [VALUE] Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. More information is available in section 1.8 Channel Labels and...
  • Page 174 Changes the settings for Slot 1 on a D20 receiver Syntax EP EXP_D20MIC <EPN> SLOT1 <PN> [VALUE] Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. More information is available in section 1.8 Channel Labels and...
  • Page 175 CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default RF_CHAN_ Use to set or retrieve the RF 1 to 8=channel number See note NUM (2) channel being used by the under Leave blank to retrieve current value slot. Value. Note: The default channel value is chosen based on the Plink position and slot number.
  • Page 176 Changes the settings for Slot 2 on a D20 receiver Syntax EP EXP_D20MIC <EPN> SLOT2 <PN> [VALUE] Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. Back to Table of Contents...
  • Page 177 CONVERGE Pro 2 Serial Commands Reference Manual More information is available in section 1.8 Channel Labels and Groups. Input Description Value Default NAME (1) Change the Slot 2 name. A name. Can be up to 10 characters, and can include uppercase alphanumeric characters (A to Z and 0 to 9) and spaces.
  • Page 178 Retrieves information about a DIALOG 20 receiver Syntax EP EXP_D20MIC <EPN> UNIT <PN> Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. Back to Table of Contents...
  • Page 179 Retrieves firmware version information of a DIALOG 20 receiver Syntax EP EXP_D20MIC <EPN> VERSION <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of Back to Table of Contents DOC-0293-001 v.1.9 October 2020...

  • Page 180: Exp_Gpio

    Retrieves the serial number of a GPIO expander Syntax EP EXP_GPIO <EPN> EXP <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 181 Retrieves information about a GPIO Expander unit Syntax EP EXP_GPIO <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 182 Locates a GPIO Expander unit by having its LED light blink Syntax EP EXP_GPIO <EPN> LOCATE <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 183 CONVERGE Pro 2 Serial Commands Reference Manual Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 184 Retrieves the serial number of a GPIO expander Syntax EP EXP_GPIO <EPN> UNIT <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 185: Exp_Usb

    CONVERGE Pro 2 Serial Commands Reference Manual Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 186 Locates a USB Expander attached to a CP2 Syntax EP EXP_USB <EPN> LOCATE <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 187 CONVERGE Pro 2 Serial Commands Reference Manual TIMEOUT EP USBExp1 LOCATE TIMEOUT 15 EP-EXP_USB (34) SERIAL_PORT (2) Function Retrieves or changes the serial port settings for a USB Expander device Syntax EP EXP_USB <EPN> SERIAL_PORT <PN> Note: The serial port settings are for pass-through of serial port information via the Euroblock connector on the device.
  • Page 188 Retrieves information about a USB Expander Syntax EP EXP_USB <EPN> UNIT <PN> Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 189 Retrieves firmware version information of a USB Expander Syntax EP EXP_USB <EPN> VERSION <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 190: Fader

    Changes the level of a fader channel Syntax EP FADER <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 191: Gpio

    Changes or retrieves the settings for GPIO pins Syntax EP GPIO <EPN> PIN <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 192: Mic

    Manages the Acoustic Echo Cancellation (AEC) of a microphone Syntax EP MIC <EPN> AEC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 193 Syntax EP MIC<EPN>AGC <PN>[VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 194 CONVERGE Pro 2 Serial Commands Reference Manual TARGET_LEVEL (2) T arget Level sets the dB level for -30 = 20, in increments of 0.5 AGC to maintain Leave blank to retrieve current value RESPONSE_TIME Response Time sets the amount 100 = 10000 in increments of 2000 of time (in ms) over which the level is averaged before AGC is enable...
  • Page 195 EP MIC <EPN> AGC_ALC <PN> [VALUE] Note: AGC settings are adjusted via the EP MIC AGC command/parameter. Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 196 CONVERGE Pro 2 Serial Commands Reference Manual Syntax EP MIC <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information. Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers.
  • Page 197 CONVERGE Pro 2 Serial Commands Reference Manual SFT (5) Sets the Slope Filter Type 2 = low 3 = high Note: Applies only to the crossover filter types (8, 9, and 10). BW (6) Set the difference between the upper 0.05 to 5 in increments of 0.01 0.33 and lower points of a filter’s audio pass...
  • Page 198 Syntax EP MIC<EPN>GATING <PN>[VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 199 CONVERGE Pro 2 Serial Commands Reference Manual NONE (2) Assign the mic to a “None” gating 0 = Disable group. 1 = Enable Note: If you have assigned a MIC 2 = Toggle Current State channel to the NONE group and to a numbered group, the NONE group Note: Inputs are routed to takes precedence.
  • Page 200 CONVERGE Pro 2 Serial Commands Reference Manual GATE_RATIO (9) Gate Ratio allows you to specify how -50dB to 0dB, in increments much louder of 0.5. the audio level must be than the Leave blank to retrieve ambient level before the channel current value automatically gates on.
  • Page 201 Changes the level and source of a microphone channel Syntax EP MIC <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 202 CONVERGE Pro 2 Serial Commands Reference Manual GAIN_FINE (1) Fine gain. Default decibel range of -65 to 20 unless adjusted with MAX_GAIN or MIN_GAIN, adjust in increments of Note: More information about gain or fine gain is available at the beginning of the EP section.
  • Page 203 CONVERGE Pro 2 Serial Commands Reference Manual DIG_SRC (9) Whether the channel signal Leave blank for Analog (using the comes from the Mic connector Mic connector on the back panel) (analog) or a digital channel Specify a DANTE_RX or D20MIC (DANTE_RX or D20MIC).
  • Page 204 Syntax EP MIC <EPN> NC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 205 Specifies the settings for a signal generator Syntax EP MIC <EPN> SIG_GEN <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 206 Enables compression on an output channel based on configurable parameters Syntax EP OUTPUT <EPN> COMPRESSOR <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 207 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default ENABLE (1) Turn on the compression feature. 0 = Disable 1 = Enable 2 = Toggle Current State Leave blank to retrieve current value GROUP (2) Use to add a compressor to a group, 0 = 4.
  • Page 208 CONVERGE Pro 2 Serial Commands Reference Manual DELAY (9) An amount of time, in ms, after the 0 = 250 in increments of threshold is exceeded and before compression begins. Leave blank to retrieve current value * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction.
  • Page 209 Sets a signal delay value for an output end point Syntax EP OUTPUT<EPN> DELAY<PN>[VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 210 Configures the Filter_1 settings of an output end point Syntax EP OUTPUT <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 211 CONVERGE Pro 2 Serial Commands Reference Manual FCY (2) Set the center frequency (in 20 to 20000 in increments of 0.01 1000 Hz). Leave blank to retrieve current value GAIN (3) Set the gain value. -15 to 15 in increments of 0.01 Leave blank to retrieve current value Note: Applies only to type 4, low shelving, type 5, high...
  • Page 212 CONVERGE Pro 2 Serial Commands Reference Manual Sets the slope filter type (SFT) to EP ChannelName FILTER_1 SFT 2 low for FILTER_1 on a MIC channel with the label Sets the bandwidth to 2.33 = EP ChannelName FILTER_1 BW 2.33 FILTER_1 on a MIC channel with the label ChannelName ENABLE...
  • Page 213 Changes the graphic equalizer settings of an output end point Syntax EP OUTPUT <EPN> GRAPHIC_EQ <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 214 CONVERGE Pro 2 Serial Commands Reference Manual GAIN_5 (6) The amount of gain, in dB, to -12 to 12 in increments of 1 apply to band 5, 500 Hz. Note: More information about gain or fine gain is available at the beginning of the section.
  • Page 215 Changes the level, polarity, and type (analog only or analog and digital) of an output channel Syntax EP OUTPUT <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 216 CONVERGE Pro 2 Serial Commands Reference Manual MUTE (2) Mute 0 = unmute 1 = mute 2 = Toggle Current State Leave blank to retrieve current value POLARITY (3) Reverse the polarity. 0 = leave polarity as is 1 = reverse polarity 2 = Toggle Current State Leave blank to retrieve current value MICLINE (4)
  • Page 217 Syntax EP OUTPUT <EPN> LIMITER <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 218: Proc

    Syntax EP PROC <EPN> COMPRESSOR <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 219 CONVERGE Pro 2 Serial Commands Reference Manual ENABLE (1) Turn on the compression feature. 0 = Disable 1 = Enable 2 = Toggle Current State Leave blank to retrieve current value GROUP (2) Use to add a compressor to a group, all 0 = 4.
  • Page 220 CONVERGE Pro 2 Serial Commands Reference Manual introduction. Examples Name Function Example Command ENABLE Turns on compression for a PROC EP ChannelName COMPRESSOR ENABLE 1 channel with the label Channel- Name GROUP Adds a PROC channel with the EP ChannelName COMPRESSOR GROUP 1 label ChannelName to compressor group 1 POST_GAIN...
  • Page 221 Sets a delay for a processor end point Syntax EP PROC <EPN> DELAY <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 222 Configures the Filter_1 settings of a processor (PROC) end point Syntax EP PROC <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 223 CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default TYPE (1) Select a filter type. Allowable filter types are: 0 (filter is off) Note: You must send this parameter first, because when you send this 1 (all pass) parameter, the rest of the filter settings are set to their default values.
  • Page 224 CONVERGE Pro 2 Serial Commands Reference Manual ENABLE (7) Enable or disable this filter. 0 = Disable 1 = Enable 2 = Toggle Current State Leave blank to retrieve current value * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction.
  • Page 225 CONVERGE Pro 2 Serial Commands Reference Manual EP-PROC (9) FILTER_2 (5) The settings for this parameter are the same as for the PROC Filter_1 parameter. Related reference: EP-PROC (9) FILTER_1 (4) EP-PROC (9) FILTER_3 (6) The settings for this parameter are the same as for the PROC Filter_1 parameter. Related reference: EP-PROC (9) FILTER_1 (4) EP-PROC (9) FILTER_4 (7)
  • Page 226 Changes the level of a processor. Syntax EP PROC <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 227 CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default GAIN (1) Gain Default decibel range of -65 to 20 unless adjusted with MAX_GAIN or MIN_GAIN, adjust in increments of 0.5 Note: More information about gain or fine gain is available at the beginning of the EP section.

  • Page 228: Speaker

    Syntax EP SPEAKER <EPN> COMPRESSOR <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 229 CONVERGE Pro 2 Serial Commands Reference Manual THRESHOLD (4) The level at which the compressor -60 = 20 in increments of 0.5. is invoked, in dB. Leave blank to retrieve current value ATTACK (5) The signal reduction increment 0 = 100 in increments of 0.5. value, in dB, used to compress the Leave blank to retrieve current signal.
  • Page 230 Sets a delay for a speaker end point Syntax EP SPEAKER <EPN> DELAY <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. Back to Table of Contents...
  • Page 231 Configures the Filter_1 settings of a speaker end point Syntax EP SPEAKER <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 232 CONVERGE Pro 2 Serial Commands Reference Manual TYPE (1) Select a filter type. Allowable filter types are: 0 (filter is off) Note: You must send this parameter first, because when you send this 1 (all pass) parameter, the rest of the filter settings are set to their default values.
  • Page 233 CONVERGE Pro 2 Serial Commands Reference Manual * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction. Examples Name Function Example Command TYPE Selects a low pass filter type for EP ChannelName FILTER_1 TYPE 1 FILTER_1 on a speaker channel with the label ChannelName...
  • Page 234 Changes the graphic equalizer settings of a speaker end point Syntax EP SPEAKER <EPN> GRAPHIC_EQ <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 235 CONVERGE Pro 2 Serial Commands Reference Manual GAIN_3 (4) The amount of gain, in dB, to apply to -12 to 12 in increments of 1 band 3, 125 Hz. Note: More information about gain or fine gain is available at the beginning of the EP section.
  • Page 236 CONVERGE Pro 2 Serial Commands Reference Manual GAIN_9 (10) The amount of gain, in dB, to apply to -12 to 12 in increments of 1 band 9, 8000 Hz. Note: More information about gain or fine gain is available at the beginning of the EP section.
  • Page 237 Reference Manual Syntax EP SPEAKER <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 238 CONVERGE Pro 2 Serial Commands Reference Manual * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction. Examples Name Function Example Command GAIN Changes the gain of a SPEAKER EP ChannelName LEVEL GAIN 5.5 channel with the label ChannelName Note: More information about gain or fine gain is available at the...

  • Page 239: Srmic

    CONVERGE Pro 2 Serial Commands Reference Manual Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 240 CONVERGE Pro 2 Serial Commands Reference Manual GAIN (1) Gain. 0 = 18dB range in increments of 0.5 Leave blank to retrieve current value TARGET_LEVEL Target Level sets the dB level for -30 = 20, in increments of 0.5 AGC to maintain. Leave blank to retrieve current value RESPONSE_TIME...
  • Page 241 EP SRMIC <EPN> AGC_ALC <PN> [VALUE] Note: AGC settings are adjusted via the EP SRMIC AGC command/parameter. Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 242 Configures the Filter_1 settings of an sound reinforcement microphone (SRMIC) channel Syntax EP SRMIC <EPN> FILTER_1 <PN> [VALUE] Note: You can also use the FILTER command to change filter settings. ClearOne recommends the use of the FILTER command. See FILTER for more information.
  • Page 243 CONVERGE Pro 2 Serial Commands Reference Manual * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction. Examples Name Function Example Command TYPE Selects a low pass filter type for EP ChannelName FILTER_1 TYPE 1 FILTER_1 on an SRMIC channel with the label ChannelName...
  • Page 244 Syntax EP SRMIC<EPN> GATING<PN>[VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 245 CONVERGE Pro 2 Serial Commands Reference Manual ADAPT_AMB (6) Adapt Ambient automatically adjusts 0 = Disable the ambient reference level as noise 1 = Enable and room conditions change. 2 = Toggle Current State Leave blank to retrieve current value AMB_LEVEL (7) Ambient Level lets you manually -80dB to 0dB, in increments...
  • Page 246 CONVERGE Pro 2 Serial Commands Reference Manual PA_ADAPT Enables the power amplifier adapt EP ChannelName GATING PA_ADAPT 1 on a SRMIC channel with the label ChannelName AMB_ADAPT Enables ambient adapt on a SRMIC EP ChannelName GATING AMB_ADAPT 1 channel with the label ChannelName AMB_TRK Adjusts the ambient level on a EP ChannelName GATING AMB_TRK -63.5...
  • Page 247 Changes the level and type (analog or digital) of an SRMIC channel Syntax EP SRMIC <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 248 CONVERGE Pro 2 Serial Commands Reference Manual DIG_SRC (9) Whether the channel signal Leave blank for Analog (using the comes from the Mic connector Mic connector on the back panel) (analog) or a digital channel Specify a DANTE_RX or D20MIC (DANTE_RX or D20MIC).
  • Page 249 Specifies the settings for a signal generator Syntax EP SRMIC <EPN> SIG_GEN <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 250: Telco_Rx

    Configures the Automatic Level Control (ALC) settings of a TELCO_RX channel Syntax EP TELCO_RX <EPN> ALC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 251 Syntax EP TELCO_RX <EPN> CE <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 252 Turns on echo cancellation (EC) for a TELCO_RX channel Syntax EP TELCO_RX<EPN> EC<PN>[VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 253 CONVERGE Pro 2 Serial Commands Reference Manual Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 254 Sends key commands (the equivalent of pressing keys on a phone) to a TELCO_RX device Syntax EP TELCO_RX <EPN> KEY <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 255 Changes the level of a TELCO_RX channel Syntax EP TELCO_RX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 256 CONVERGE Pro 2 Serial Commands Reference Manual BOOST_LEVEL (4) Amount to boost the TELCO_ 0 = 12 in increments of 3 RX channel level prior to Leave blank to retrieve current processing. value DTMF_LEVEL (5) Change the level of the -12 to 12 in increments of 0.5 tones played when keys are Leave blank to retrieve current...
  • Page 257 Syntax EP TELCO_RX <EPN> NC <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 258 Note: The EP TELCO_RX NOTIFICATION messages are asynchronous notifications that can be received from a CONVERGE Pro 2 box, but cannot be sent to the box. Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers.
  • Page 259 Changes the settings for a TELCO_RX channel Syntax EP TELCO_RX <EPN> SETTINGS <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 260 CONVERGE Pro 2 Serial Commands Reference Manual HOOK_FLASH_DURATION (5) This feature is dependent on 50 to 2000 in the services offered by your increments of 0.5 telephone company. Range is Leave blank to 50ms to 2 seconds. retrieve current value RING_ENABLE (6) Whether the ringer is enabled.
  • Page 261 CONVERGE Pro 2 Serial Commands Reference Manual COUNTRY_CODE (12) Set the country code for the 1 = USA/Canada device to specify which telco 2 = Europe standards 3 = Mexico are used. 4 = Australia 5 = South Africa 6 = Japan 7 = Brazil 8 = South Korea 9 = China...
  • Page 262 CONVERGE Pro 2 Serial Commands Reference Manual RING_TYPE Sets the ring type for a TELCO_RX EP ChannelName SETTINGS RING_TYPE channel with the label ChannelName ADAPT Turns on the adapt setting for a EP ChannelName SETTINGS ADAPT 1 TELCO_RX channel with the label ChannelName HOOK_FLASH_ Sets the hook flash duration for a...
  • Page 263 CONVERGE Pro 2 Serial Commands Reference Manual COUNTRY_CODE Sets the country code for a EP ChannelName SETTINGS COUNTRY_ TELCO_RX channel with the label CODE 1 ChannelName LAST_DIALED_DIGITS Returns the last dialed digits using a EP ChannelName SETTINGS LAST_ KEY_CALL command while on-hook DIALED_DIGITS for a TELCO_RX channel with the label ChannelName...
  • Page 264 CONVERGE Pro 2 Serial Commands Reference Manual STATE SOFT KEY/ACTION ACTION IDLE Incoming call Box returns: EP TELCO_RX <X> NOTIFICATION INCOMING_CALL 1 EP TELCO_RX <X> NOTIFICATION CALLER_ID<CID> Transition to State 3 CALL NUMBER Send to box: EP TELCO_RX <X> KEY KEY_CALL <Digits> Box returns: EP TELCO_RX <X>...
  • Page 265 CONVERGE Pro 2 Serial Commands Reference Manual DIAL TONE END CALL Send to box: EP TELCO_RX <X> KEY KEY_HOOK 0 Box returns: EP TELCO_RX <X> NOTIFICATION HOOK 0 EP TELCO_RX <X> NOTIFICATION CALL_DURATION <time off-hook> Transition to State 0 CALL NUMBER Send to box: EP TELCO_RX <X>...

  • Page 266: Telco_Tx

    CONVERGE Pro 2 Serial Commands Reference Manual ENTER DIGITS Send to box: EP TELCO_RX <X> KEY KEY_DIGIT_PRESSED <Digit> EP TELCO_RX <X> KEY KEY_DIGIT_RELEASED <Digit> When no digits have been collected for 20 seconds, transition to state 4 INCOMING ANSWER Send to box: EP TELCO_RX <X>...
  • Page 267 CONVERGE Pro 2 Serial Commands Reference Manual Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 268 CONVERGE Pro 2 Serial Commands Reference Manual MIN_GAIN Sets minimum gain for a EP ChannelName LEVEL MIN_GAIN -50 TELCO_TX channel with the label ChannelName Output Output GAIN EP ChannelName LEVEL GAIN 5.5 MUTE EP ChannelName LEVEL MUTE 1 MAX_GAIN EP ChannelName LEVEL MAX_GAIN 40 MIN_GAIN EP ChannelName LEVEL MIN_GAIN -50 2.4.24 UA...
  • Page 269 CONVERGE Pro 2 Serial Commands Reference Manual Output REG_STATUS (1) Returns the SIP server registration status. Possible values: NO_PROXY_DEFINED - No primary or secondary proxy has been defined. NOT_ REGISTERED - A proxy is defined, but the UA is currently registered with the proxy. REGISTERED_PRIMARY - A proxy is defined and the UA is registered to the primary SIP proxy.
  • Page 270 CONVERGE Pro 2 Serial Commands Reference Manual ACTIVE_PARTIES (2) DIALING;<CallPartyDigits> - The party line is off-hook and party digits have been entered. <CallPartyDigits> shows digits dialed thus far. INPROCESS;<CallParty> - An outbound call has been initiated to <CallParty> and the call is in progress. RINGING;<CallParty> - An outbound call has been made to <CallParty>...
  • Page 271 Sends key commands (the equivalent of pressing keys on a phone) to a UA channel Syntax EP UA <EPN> KEY <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 272 CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default KEY_BLIND_TRANSFER Use to initiate a blind transfer (a transfer with no introduction) and, once you have dialed another party, complete the transfer KEY_CONFERENCE (6) Use to initiate a conference 0 to 5 call and, once you have dialed another party, add that party to the conference call...
  • Page 273 CONVERGE Pro 2 Serial Commands Reference Manual Description Value Default KEY_DO_NOT_DISTURB Turn on the Do Not 0 = Disable (14) Disturb feature 1 = Enable 2 = Toggle current state KEY_PLAY_RINGTONE Play any of the 5 ring- 0 to 5 (15) tones * The meaning of the entries in this column is available in the...
  • Page 274 CONVERGE Pro 2 Serial Commands Reference Manual KEY_PARTY Selects party line 1 for a EP ChannelName KEY KEY_PARTY 1 UA channel with the label ChannelName KEY_HOOK Changes the hook status on EP ChannelName KEY KEY_HOOK 1 a UA channel with the label ChannelName KEY_MUTE Enables mute on a UA channel with...
  • Page 275 CONVERGE Pro 2 Serial Commands Reference Manual INDICATION Used to provide a notification that some kind of indicator has changed. Possi- ble values: EP UA <X> NOTIFICATION INDICATION PL NA;HOLD:<ON|OFF> EP UA <X> NOTIFICATION INDICATION PL NA;MUTE:<ON|OFF> EP UA <X> NOTIFICATION INDICATION PL <1-5>;PARTY_ LINE:<ON|OFF| BLINK>...
  • Page 276 Changes the settings for a UA channel Syntax EP UA <EPN> SETTINGS <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 277 CONVERGE Pro 2 Serial Commands Reference Manual * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction. Examples Name Function Example Command UA_ENABLE Enables SIP on a UA channel EP ChannelName SETTINGS UA_ENABLE 1 with the label ChannelName USERNAME Specifies the username for...
  • Page 278 CONVERGE Pro 2 Serial Commands Reference Manual ACTIVE_RINGTONE EP ChannelName SETTINGS ACTIVE_RINGTONE 3 LABEL EP UA 101 SETTINGS MyChannelName AUTO_ANSWER EP ChannelName SETTINGS AUTO_ANSWER 1 VOIP States The following table describes the possible Voice Over IP (VOIP) states, state transitions, and the serial commands sent to and received from a box during VOIP processes.
  • Page 279 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action IDLE Incoming Call Box Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; INCOMING:<CallParty> Transition to State ID 8 OFF-HOOK Send to box: EP UA <X> KEY KEY_HOOK Box returns: EP UA <X>...
  • Page 280 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action DIAL TONE END CALL Send to box: EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 DIAL NUMBER/SIP Send to box: EP UA <X>...
  • Page 281 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action DIALING END CALL Send to box: EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 ENTER DIGITS Send to box: EP UA <X>...
  • Page 282 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action INPROCESS END CALL Send to box: EP UA<X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 Call progresses to the Box returns: RINGING state EP UA <X>...
  • Page 283 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action BUSY END CALL Send to box: EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 ACTIVE Remote party discon- Box returns: nects EP UA <X>...
  • Page 284 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action ACTIVE CONFERENCE Send to box for each party that is on HOLD: EP UA <X> KEY KEY_CONFERENCE <1-5> EP UA <X> KEY KEY_CONFERENCE This will add all HOLD parties to the current call and create a conference call.
  • Page 285 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action ACTIVE NEW CALL Send to box: EP UA <X> KEY KEY_HOLD Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; HOLD:<CallParty> Transition to State ID 7 for current call Send to box: EP UA <X>...
  • Page 286 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action HOLD CONFERENCE Send to box for each party that is on HOLD (except for the current party): EP UA <X> KEY KEY_CONFERENCE <1-5> EP UA <X> KEY KEY_CONFERENCE This will add all HOLD parties to the Current call and create a conference call.
  • Page 287 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action INCOMING ANSWER If other lines are active, send to box: EP UA <X> KEY KEY_HOLD Box returns: EP UA <X> NOTIFICATION STATE_CHANGE PL <1- 5>; HOLD:<CallParty> for each active line (there may be multiple lines in case of conference) Send to box: EP UA <X>...
  • Page 288 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action CONFERENCE_ END CALL Send to box: ACTIVE EP UA <X> KEY KEY_HOOK Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1- 5>;IDLE Transition to State ID 0 for all parties in the conference CONFERENCE_ Remote party discon- Box returns:...
  • Page 289 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action CONFERENCE_ NEW CALL Send to box: HOLD EP UA <X> KEY KEY_PARTY <1-5> (where <1-5>represents a free line) Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; DIAL_TONE Transition to State ID 1 for the new line Note: This key should not be presented if all lines are in use.
  • Page 290 CONVERGE Pro 2 Serial Commands Reference Manual TRANSFERRING_DIAL_TONE CANCEL Send to box: TRANSFER EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 DIAL NUMBER/SIP Send to box: EP UA <X> KEY KEY_CALL <target # or SIP URI>...
  • Page 291 CONVERGE Pro 2 Serial Commands Reference Manual TRANSFERRING_DIALING CANCEL TRANSFER Send to box: EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 ENTER DIGITS Send to box: EP UA <X> KEY KEY_DIGIT_PRESSED <Digit>...
  • Page 292 CONVERGE Pro 2 Serial Commands Reference Manual State Soft Key/Action Action Call progresses to Box returns: the BUSY state EP UA <X> NOTIFICATION STATE_ CHANGE <1-5>; TRANSFERRING_BUSY: <CallParty> Transition to State ID 16 Call progresses to Box returns: the ACTIVE state EP UA <X>...
  • Page 293 CONVERGE Pro 2 Serial Commands Reference Manual TRANSFERRING_RINGING CANCEL Send to box: TRANSFER EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 COMPLETE Send to box: TRANSFER EP UA <X> KEY KEY_TRANSFER Box returns: EP UA <X>...
  • Page 294 CONVERGE Pro 2 Serial Commands Reference Manual TRANSFERRING_BUSY END CALL Send to box: EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 TRANSFERRING_ACTIVE CANCEL Send to box: TRANSFER EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X>...
  • Page 295 CONVERGE Pro 2 Serial Commands Reference Manual BLIND_TRANSFER_HOLD Transfer canceled Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; HOLD:<CallParty> Transition to State ID 7 Transfer completed When remote party answers, box returns: EP UA <X> NOTIFICATION STATE_CHANGE PL <1-5>;IDLE Transition to State ID 0 Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 296 CONVERGE Pro 2 Serial Commands Reference Manual BLIND_ TRANSFERRING_ CANCEL Send to box: DIALTONE TRANSFER EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>;IDLE Transition to State ID 0 DIAL NUMBER/ Send to box: SIP URI EP UA <X>...
  • Page 297 CONVERGE Pro 2 Serial Commands Reference Manual BLIND_TRANSFERRING_ CANCEL Send to box: DIALING TRANSFER EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>;IDLE Transition to State ID 0 ENTER DIGITS Send to box: EP UA <X> KEY KEY_DIGIT_PRESSED <Digit>...
  • Page 298 CONVERGE Pro 2 Serial Commands Reference Manual BLIND_TRANSFERRING_ END CALL Send to box: INPROCESS EP UA <X> KEY KEY_PARTY <1-5> Box returns: EP UA <X> NOTIFICATION STATE_CHANGE <1-5>; IDLE Transition to State ID 0 Call progresses to Box returns: the RINGING state EP UA <X>...

  • Page 299: Usb_Rx

    Changes the level of a USB_RX end point Syntax EP USB_RX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 300 CONVERGE Pro 2 Serial Commands Reference Manual Input Description Value Default GAIN (1) Gain Default decibel range of -65 to 20 unless adjusted with MAX_GAIN or MIN_GAIN, adjust in increments of Note: More information about gain or fine gain is available at the beginning of the EP section.

  • Page 301: Usb_Tx

    Changes the level of a USB_TX end point Syntax EP USB_TX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 302: Usbe_Rx

    CONVERGE Pro 2 Serial Commands Reference Manual MIN_GAIN (4) Minimum gain. This -65 to 20, in increments of 0.5 controls Leave blank to retrieve current value how low gain can be set, and also how low ramping can go. * The meaning of the entries in this column is available in the Read/Write Modes section of this document’s introduction.
  • Page 303 Reference Manual Syntax EP USBE_RX <EPN> EXP <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.
  • Page 304 CONVERGE Pro 2 Serial Commands Reference Manual MUTE (2) Mute 0 = Unmute 1 = Mute 2 = Toggle current state Leave blank to retrieve current value MAX_GAIN (5) Maximum gain. This -65 to 20, in increments of 0.5 controls how high gain Leave blank to retrieve current value can be set, and also how high ramping can go.

  • Page 305: Usbe_Tx

    Changes the level of a USBE_TX channel (a transmit channel of a USB expander) Syntax EP USBE_TX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 306: Voip_Rx

    Function Changes the level of a VOIP_RX channel Syntax EP VOIP_RX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of Back to Table of Contents DOC-0293-001 v.1.9 October 2020...
  • Page 307 CONVERGE Pro 2 Serial Commands Reference Manual channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups. Input Description Value Default GAIN (1) Gain Default decibel range of -65 to 20 unless adjusted with MAX_GAIN or MIN_GAIN, adjust in increments of Note: More information about gain or fine gain is available at the...

  • Page 308: Voip_Tx

    Changes the level of a VOIP_TX channel Syntax EP VOIP_TX <EPN> LEVEL <PN> [VALUE] Tip: Even though you can use channel numbers in commands, ClearOne strongly recommends the use of channel labels rather than channel numbers. More information is available in the Section 1.8 Channel Labels and Groups.

  • Page 309: Ramp

    CONVERGE Pro 2 Serial Commands Reference Manual MAX_GAIN (5) Maximum gain. This controls how -65 to 20, in increments of high gain can be set, and also how high ramping can go. Leave blank to retrieve current value MIN_GAIN (6) Minimum gain.
  • Page 310 RAMP command lowers the level at the specified rate until the target is reached. Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names.
  • Page 311 5=Pre-AEC Note: Types 3, 4, and 5 apply only to MIC end points. Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. More information is available in section 1.8 Channel Labels and...

  • Page 312: Clrmatrix

    EP command) Syntax FILTER <EPT> <EPN> <FILTER_NO> <ENABLE> <TYPE> [P1] [P2] [P3] Tip: Instead of sending an EPT and EPN combination to identify an end point channel, ClearOne strongly recommends that you use Group names. More information is available in section 1.8 Channel Labels and...
  • Page 313 CONVERGE Pro 2 Serial Commands Reference Manual FILTER_NO The number of the filter to change. PROC end points allow up to 15 filters. The BFM, MIC, OUTPUT , SPEAKER, and SRMIC end points allow up to 4 filters. Note: You can include only the first three parameters as a read-only command to query the existing filter state.
  • Page 314 CONVERGE Pro 2 Serial Commands Reference Manual Butterworth Crossover SLOPE Linkwitz-Riley Crossover SLOPE Notch Table 3: Type-Specific Parameter Descriptions Description Value Default Sets the center frequency (in Hz) 20 to 20000 in increments of 0.01. 1000 Note: Applies to all types. Note: CD HORN uses a frequency range of 500 = 5000 in increments of 0.01.

  • Page 315: Gate

    CONVERGE Pro 2 Serial Commands Reference Manual Turns on a Bessel Crossover filter and FILTER WallSpeaker 1 1 8 1000 12 3 set its FCY to 1000, its SLOPE to 12 and its SFT to high to on Filter 1 of a Note: This example changes the frequency and the BW but channel with the label WallSpeaker leaves the GAIN value unchanged if you’re not changing the filter...
  • Page 316 CONVERGE Pro 2 Serial Commands Reference Manual Parameters Parameter Description BOXNAME The name of a box. Use * to indicate all attached boxes. Time Out Value. How long to let the command run in seconds. You can enter up to 4 digits. Note: Enter a TOV of 0 to stop the report.

  • Page 317: Gategroup

    CONVERGE Pro 2 Serial Commands Reference Manual The first field shows that this is a report for a device GATEREPORT 1 60 1 1 000000001000 13 010 with a DID of 1. The second field shows that the gating report is scheduled to run for 60 more seconds.
  • Page 318 Leave blank to retrieve current value Note: ClearOne recommends using First Mic Priority to maintain maximum audio intelligibility by allowing only one microphone to gate on to a participant’s voice.
  • Page 319 CONVERGE Pro 2 Serial Commands Reference Manual PROPERTY (1) LAST_MIC (3) Enable the Last Mic feature. If you [Value1]: don’t specify a MICLABEL, this 0 for off feature leaves the last microphone activated gated on and all other 1 = on mics gated off until another microphone gates on.

  • Page 320: Meter

    CONVERGE Pro 2 Serial Commands Reference Manual 2.11 METER 2.11.1 METER Function, Syntax, Parameters Function Reads several types of meters from a CONVERGE Pro 2. Syntax METER <TOV> <EPT> <EPN> <MT> Arguments Argument Description Time Out Value. How long to let the command run in seconds. You can enter up to 4 digits.

  • Page 321: Meterpresent

    CONVERGE Pro 2 Serial Commands Reference Manual example), 101 is the Endpoint number, and -83 is the level in dB. 2.12 METERPRESENT 2.12.1 METERPRESENT Function, Syntax, Parameters Function View presence and clipping information for a box. The information is returned via a LEVELPRESENT command.

  • Page 322: Reset

    CONVERGE Pro 2 Serial Commands Reference Manual 2.14.1 VERSION Function, Syntax, Parameters Function Retrieves the firmware version of a CONVERGE Pro 2 box Syntax VERSION <BOXNAME> <TYPE> 1 Parameters Parameter Description BOXNAME The name of a box. Use * to indicate all attached boxes. TYPE The version type to request: FW Firmware of the specified CP2 device(s)

  • Page 323: Factorydefault

    CONVERGE Pro 2 Serial Commands Reference Manual Function Resets a CONVERGE Pro 2 box Syntax RESET <BOXNAME> Parameters Parameter Description BOXNAME The name of a box. Use * to indicate all attached boxes. 2.16 FACTORYDEFAULT 2.16.1 FACTORYDEFAULT Function, Syntax, Parameters Function Resets a CONVERGE Pro 2 device and return it to its factory settings.
  • Page 324 CONVERGE Pro 2 Serial Commands Reference Manual Description Example Command The Beam Report displayed on the serial port appears 48 101 000000000001 BEAMREPORT 1 4 1 as follows: 48 101 000000000001 The value highlighted in the first line is the EPT (48) BEAMREPORT 1 0 1 value of the BMA360 endpoint.

  • Page 325: Clock

    CONVERGE Pro 2 Serial Commands Reference Manual 2.18 CLOCK 2.18.1 CLOCK Function, Syntax, Parameters Function CLOCK is a read/write command. It sets and retrieves date and time information. Syntax CLOCK <M> <DD> <YYYY> <HH> <MM> <SS> Parameters Parameter Description M, DD, YYYY Numerical value of month, day of month, year HH, MM, SS Hour (in 24 hour time), minutes, seconds...

  • Page 326: Change History

    CONVERGE Pro 2 Serial Commands Reference Manual 3. Change History Rev 1.9, October 2020 Topics Added 2.2.9 Box UNIT PNs: FTP_ENABLE TELNET_ENABLE SSH_ENABLE FAN_SPEED TEMP_LOCAL TEMP_REMOTE 2.2.15 Box-TEMP 2.2.16 Box-FAN 2.4.3 BMA360 2.4.4 BMA360_SPKR REFGAIN for BFM EP 2.11 METER 2.17 BEAM 2.18 CLOCK Topics Edited...

  • Page 327: Rev. 1.8, March 2018

    CONVERGE Pro 2 Serial Commands Reference Manual Rev. 1.8, March 2018 Topics Edited Topic Description of Edit EP-SFBUA (27) KEY (1) Added more details on arguments used for KEY parameters. Added KEY_SEND_IM (4) parameter. Added KEY_PRESENCE (14) parameter. EP-SFBUA (27) INQUIRE (2) Added more details on arguments used for INQUIRE parameters.

  • Page 328: Rev. 1.6, October 2017

    CONVERGE Pro 2 Serial Commands Reference Manual BOX-VOIP_PORT (15) Added STATIC_DOMAIN_NAME parameter BOX-VLAN_VOIP (9) Added STATIC_DOMAIN_NAME parameter BOX-UNIT (1) Added VOIP_MODE parameter EP-TELCO_RX (3) SETTINGS (2) Added RING_ENABLE and AUDIBLE_CONNECT_ENABLE parameters EP-TELCO_RX (3) KEY (3) Added KEY_SPEED_DIAL parameter EP-UA (20) INQUIRE (2) Added MAX_CALLS_PER_UA parameter EP-UA (20) INQUIRE_RESULT (3) Added MAX_CALLS_PER_UA parameter...
  • Page 329 CONVERGE Pro 2 Serial Commands Reference Manual BOX-ETHERNET_PORT (6) Renamed SUBNET_MASK (3) to STATIC_SUBNET (3) Renamed GATEWAY_IP (4) to STATIC_GATEWAY (4) Renamed DNS_IP (5) to STATIC_DNS (5) Renamed ALT_DNS_IP (6) to STATIC_ALT_DNS (6) Renamed IP_ASSIGN_MODE_CHANGE (8) to UPDATE (8) Added MAC (9), IP (10), LINK_STATUS (11), SUBNET (12), GATEWAY (13), DNS (14), AND ALT_DNS (15) parameters EP Command Table Various changes, as described in the other command changes listed...

  • Page 330: Clearone Contacts

    Tel: 801.974.3760 Tel: 801.975.7200 e-mail: tech.support@clearone.com Fax: 801.303.5711 International Tel: +801.974.3621 e-mail: global@clearone.com © 2020 ClearOne, Inc. Information in this document is subject to change without notice. Document: QSG-0293-001 v1.9 August 2020 Back to Table of Contents DOC-0293-001 v.1.9 October 2020...

Table of Contents

Save PDF