beautypg.com

Appendix a: serial command guide – ClearOne Converge Pro User Manual

Page 203

background image

Appendix A: Serial Commands 199

Appendix A: SeriAl CommAnd Guide

Type and device ids

Converge/Converge pro device Types and device ids by model are as follows:

model

device Type

device id range

880

1

0-7

TH20

2

0-F

840T

3

0-7

8i

A

0-7

880T

d

0-7

Sr 1212

G

0-7

convenTions

This guide uses the following typographic conventions to describe Converge/Converge pro serial command syntax:

Convention

description

parameters enclosed in < > indicate a mandatory parameter

[X]

parameters enclosed in [ ] indicate an optional parameter

1-8

parameters separated by a ‘-‘ indicate a range of allowable values

4,7,9

parameters separated by a ‘,’ indicate a list of allowable values

eReF

Words in upperCASe bold indicate command text

device

indicates the device type and device number on the expansion Bus. it is
composed of a device type character and a device id character.

command FoRm descRipTion

The structure of serial commands is as follows:

# [values]

# indicates the start of a command line, the Carriage return terminates a command.

noTe

:

Serial commands can be either upperCASe or lowercase. return values are always in

upperCASe. in order for a command to be recognized by the rS-232 serial port, the

command must be terminated by a carriage return.

For example, a command to disable mute for mic input 5 on a Converge pro 880 with a device id of 2 would have

the command line #12 mUTe 5 m 0.

in this command line, 1 = the device Type for Converge 880, 2 = the device id for unit 2, mUTe = serial

command, 5 = the channel value, m = the channel type value for mic input channels, and 0 = the command

value that turns mute off.

if an asterisk (*) is placed in the device Type or device id fields, the command will apply to all units or all devices

respectively. For example, a command with a device Type = 1 and a device id = * would apply the command to

all Converge 880 units. A command with a device Type = * and a device id = 6 would apply the command to all

units with a device id of 6.

if a command specifies “(null to query in text)” in its value table, leave a blank in the command line to query the

current state of that value. For example, the command #12 mUTe 5 m would return the current mute

state of mic 2 on an 880 unit with a device id of 0.