Bose ControlSpace User Manual

ControlSpace®

SERIAL CONTROL PROTOCOL v5.9

Revision Date: Friday, February 19, 2021

1 About 1

2 Connection 2

Using the RS-232 Serial Port (ESP and EX only) 2

Using Serial-over-Ethernet (ESP, EX, PowerMatch and PowerShare ) 2

Using Serial-over-Ethernet (WP, EP and EX Endpoints) 3

3 Command Format 4

System and Device Commands 4

Module Commands: 4

Subscription Commands: 5

Endpoint Commands: 5

4 System Commands 6

4.1 Set/Get Parameter Set (SS, GS) 6

4.2 Set/Get Group Master Level (SG, GG) 6

4.3 Set Group Level Increment/Decrement (SH) 7

4.4 Set/Get Group Master Mute (SN, GN) 7

4.5 Set/Get Room Combine (SRC, GRC) [EX Only] 7

4.6 Set/Get Parameter Set Lists (SA, GA) 9

5 Device Commands 10

5.1 Set/Get Input/Output Volume (SV, GV) 11

5.2Set Volume Increment/Decrement (SI) 12

5.3Set/Get Input/Output Mute (SM, GM) 12

5.4 Get Signal Level (GL) 13

5.5Set/Get IP Address (IP) 15

5.6Network Parameters (NP) 15

5.7Reset/Reboot Device (RESET) 16

5.8Set/Get Standby Status (SY, GY) [PowerMatch and PowerShare Only] 17

5.9Get Configuration (GC) [PowerMatch Only] 17

5.10 Set/Get Fault Status (SF, GF) [PowerMatch Only] 17

5.11Clear Fault/Alarms (CF) [PowerMatch Only] 18

5.12 Set/Get Alarm Reporting/Status (SR, GR) [PowerMatch Only] 18

5.13 Get/Clear Alarm History/Log (GH, CH) [PowerMatch, PowerShare Only] 19

6 Module Commands 21

Set/Get Module Parameter (SA, GA), Invoke Module Action (MA) 21

i

6.1ESP/EX Module Indices 23

6.1.1Input Module 23

6.1.2Output Module 23

6.1.3ESPLink Module [ESP Only] 24

6.1.4AmpLink Module 25

6.1.5 Dante I/O Modules 25

6.1.6 CobraNet I/O Modules [ESP-00 only] 26

6.1.7Surround Input Module [ESP-00 only] 26

6.1.8PSTN Input Module [EX Only] 27

6.1.9PSTN Output Module [EX Only] 28

6.1.10VoIP Input Module [EX Only] 28

6.1.11VoIP Output Module [EX Only] 30

6.1.12 USB Input Module [EX Only] 30

6.1.13 USB Output Module [EX Only] 31

6.1.14 Acoustic Echo Canceller Module [EX Only] 31

6.1.15 AGC Module (Enhanced) [EX only] 32

6.1.16AGC Module (Legacy) 33

6.1.17Array EQ Module 34

6.1.18AMM – Gain Sharing Module [EX/1U ESP Only] 34

6.1.19 AMM - Gated Module (Legacy) [ESP Only] 35

6.1.20 AMM - Gated Module (Enhanced) [EX Only] 36

6.1.21 Compressor/Limiter Module 38

6.1.22 Conference Room Router Module [EX] 39

6.1.23 Crossover Module 42

6.1.24 Delay Module 44

6.1.25 Ducker Module 44

6.1.26 Gain Module 45

6.1.27 Gate Module 46

6.1.28 GPO Module 46

6.1.29 1/3 Octave Graphic EQ Module 47

6.1.30 Logic Input Module [EX Only] 48

6.1.31 Logic Output Module [EX Only] 48

6.1.32 Logic Processing Module [EX Only] 49

6.1.32.1 Toggle/FF Gate 49

ii

6.1.32.2 Pulse Gate 50

6.1.32.3 Debounce Gate 51

6.1.33 Matrix Mixer Module 51

6.1.34 Parametric EQ Module 52

6.1.35 Peak/RMS Limiter Module 53

6.1.36 Router Module 54

6.1.37 Signal Generator Modules 54

6.1.38 Source Selector Module 56

6.1.39 Speaker Parametric EQ Module 56

6.1.40 Standard Mixer Module 58

6.1.41Tone Control EQ Module 60

6.1.42 SmartBass Module [EX/1U ESP Only] 60

6.1.43 Dynamic EQ Module [EX/1U ESP Only] 61

6.1.44Standard Room Combiner Module 61

6.1.45 Predictive Feedback Suppression Module [EX/1U ESP Only] 61

6.2PowerMatch® and PowerShare Module Indices 63

6.2.1Input Module 63

6.2.2 Signal Generator Module [PowerMatch Only] 63

6.2.3 Input Parametric EQ Module 64

6.2.4Array EQ Module [PowerMatch Only] 65

6.2.5 Matrix Mixer Module 66

6.2.6Band Pass Module 67

6.2.7Speaker Parametric EQ Module 68

6.2.8 Limiter Module 69

6.2.9Delay Module 70

6.2.10Amp Output Module 71

7 Endpoint Commands 72

7.1ID/FU Identify Device/Find Unit 72

7.2Input Gain (IG) [EX-4ML, EX-8ML, EP40, EP22, WP22B/BU] 73

7.3Input Source (IS) [WP22BU] 73

7.4Phantom Power (PP) [EX-4ML, EX-8ML, EP40, EP22, WP22B/U] 73

7.5Output Gain (OG) [EP22] 74

7.6Read Signal Level (RSL) [EX-4ML, EX-8ML] 74

7.7Read/Write Logic Output (RLO/WLO) [EX-4ML, EX-8ML] 75

iii

7.8Read Logic Input (RLI) [EX-4ML, EX-8ML] 75

7.9Set Logic Event (EVNT) [EX-4ML, EX-8ML] 76

7.10Set Event Notification IP Address (SASIP) [EX-4ML, EX-8ML] 76

7.11Load/Save Preset (LOAD/SAVE) 77

7.12Query Audio Settings (QUERY) 77

7.13Restore Factory Defaults (DEFAULTS) 78

7.14Query Firmware Version (VERSION) 78

8 Subscription Commands 79

8.1Device Subscription Support (SUB without Argument) 79

8.2Subscribing for Data Change (SUB with Argument) 80

8.3Unsubscribing from Data Change (UNS) 81

Appendix A: PSTN Country Codes 82

iv

1 About

This ControlSpace® Serial Control Protocol document covers the following products:

l ControlSpace EX-1280C, EX-12AEC, and EX-440C conference processors

l ControlSpace EX-1280 processor

l ControlSpace ESP-880, ESP-1240, ESP-4120, ESP-1600 processors

l ControlSpace ESP-00 Series II, ESP-00, ESP-88 processors

l PowerMatch PM8500N, PM8250N, PM4500N, PM4250N amplifiers

l ControlSpace WP, EP and EX Dante™ Endpoint audio interfaces

l PowerShare PS404D, PS604D amplifiers

This protocol provides a communication mechanism for Bose ControlSpace , PowerMatch and Power­Share products to interface with third-party control systems such as AMX, Crestron, Extron, or any
other controller capable of following this protocol.

The purpose of this document is to provide programmers and integrators the necessary details on the
available commands, their behavior and syntax.

Note:

Whenever this document references the ESP-880 it applies equally to the ESP-880A and ESP-

880AD, unless otherwise specified.

Note:

Whenever this document references the ESP-1240 it applies equally to the ESP-1240A and ESP-

1240AD, unless otherwise specified.

Note:

Whenever this document references the ESP-00 it applies equally to the current ESP-00 II, and to

the legacy ESP-00 and ESP-88 processors.

PRO.BOSE.COM 1 OF 84

2 Connection

Using the RS-232 Serial Port (ESP and EX only)

When using RS-232, a 3-wire connection is sufficient to communicate with the ESP or EX processors
(use of the CTS/RTS pins on the ESP is optional). ESP Processors use a 9-way D connector configured
as DTE, so a crossover (or null-modem) cable will be required to connect directly to a PC, whereas the
EX processors use a miniature Phoenix connector and can be wired as required.

The default communication settings are shown below. If required these settings can be changed via
ControlSpace Designer™ software.

ESP-00

Baud 38,400 115,200

Data bits 8 8

Parity None None

Stop bits 1 1

ESP-880/1240/4120/1600

EX-1280C/440C/1280

RS-232 Panel Connector
Pinout (DTE)

Using Serial-over-Ethernet (ESP, EX, PowerMatch and PowerShare )

ESP, EX, PowerMatch (networked) and PowerShare products can be controlled via serial commands
sent over Ethernet using a TCP/IP connection. Communication is via the same physical Ethernet con­nection used for the ControlSpace Designer software but a dedicated port number (10055) is provided
for third-party control allowing them to operate simultaneously.

Note:

software to allow the new design to be loaded. The control connection can be re-established once on­line. Most control systems can do this automatically.

ESP, EX, PowerMatch (networked) and PowerShare products can support up to the maximum number
of simultaneous serial-over-Ethernet connections (in addition to the physical RS232 serial port on
ESP/EX) according to the table below:

The third-party control connection will be closed when going on-line with ControlSpace Designer

Products

EX-1280C, EX-12AEC, and EX-440C 32

EX-1280 32

ESP-880, ESP-1240, ESP-4120, ESP-1600 32

ESP-00 Series II, ESP-00, ESP-88 8

PM8500N, PM8250N, PM4500N, PM4250N 32

PS404D, PS604D 8

These connections are shared with any instances of ControlSpace Remote that use the same com­munication method. Once the maximum number of connections have been established, additional
requests will be refused until one of the existing connections is closed. Serial output and asyn­chronous feedback is sent to all active connections (including the physical RS232 port on ESP/EX)
and Serial input will monitor all active connections for the specified strings. In contrast, responses to
query commands are returned only to the connection that initiated the query.

PRO.BOSE.COM 2 OF 84

Maximum number of

SoIP connections

The ESP-00, PowerMatch and PowerShare products use a fixed port number of ‘10055’ for third-party
control connections. 1U ESPs (880/1240/4120/1600) and EX devices also use the same port by
default but allow the port to be changed or disabled via the device properties in the ControlSpace
Designer software if required.

It’s important to note that ESP, EX, PowerMatch and PowerShare products only act as Server for serial­over-Ethernet connections; the connection must be initiated by the Client device.

Using Serial-over-Ethernet (WP, EP and EX Endpoints)

Endpoints can also be controlled via serial commands sent over Ethernet, but these use UDP packets
and a fixed port number of “49494”. Where endpoints are paired with EX processors, any settings sent
to the endpoint directly can be overridden by those programmed in the processor. When paired,
changes should only be made via ControlSpace Designer software while online with the EX processor.

For reference, a list of the ports used by ControlSpace devices is provided below:

ESP, EX, PM and PS Serial-over-Ethernet 10055

ControlSpace Designer software 10001,10002

Scan/Discovery 9010

Firmware updates 9008, 9009

Inter-device communication 2005, 2006, 2007

Endpoint UDP Control 49494

Using ‘Hyperterminal’ configured for TCP/IP (as shown below) is a convenient way to test these com­mands.

Note:

tems. Freeware or open-source solutions such as ClearTerminal, RealTerm, PuTTy or Hercules are avail­able online and can be used to test commands as well.

HyperTerminal is no longer bundled with newer versions of Microsoft Windows® operating sys-

PRO.BOSE.COM 3 OF 84

3 Command Format

All commands and responses are sent using ASCII characters, terminated with a <CR> (carriage return,
ASCII 0x0D). There is no time limit between characters of a command, so it is possible to enter com­mands using a “dumb terminal”. The available commands are divided into the following categories
per their scope.

System Commands (Parameter Sets, Groups ...)

Device Commands (Inputs, Outputs, Set IP address, Get alarm status …)

Module Commands (Signal processing parameters ...)

Endpoint Commands (Input gain, Phantom power, Logic I/O ...)

System and Device Commands

Numerical values for System and Device Commands are entered using hexadecimal ASCII. For
example, 16 (decimal) is entered as 10 (hex) and 34 (decimal) is entered as 22 (hex).

> Command should be capital letters

> A space after the command is optional (SS 10 or SS10 are both acceptable)

> A comma "," is used as the separator

> Hexadecimal values do not require a suffix ("A3h" not allowed – should be "A3")

> Hexadecimal values can be sent in upper or lower case (SS A or SS a are both acceptable,

but responses are always in lower case)

> All commands are terminated with a <CR> (Carriage Return – ASCII 0x0D)

> No acknowledgement is sent. Following a ‘Set’ command with a ‘Get’ is a convenient

method for confirming the command was successful

Module Commands:

Numerical values for Module Commands are entered as simple ASCII text. For example, -28dB is
entered simply as “-28”

> Command should be capital letters

> A space after the command is optional (SA “xx” or SA“xx” are both acceptable)

> Module name must be unique and should always be enclosed in quotes (“Name”)

> Command may have 1 ,2 or 3 Indices separated by “>” (ASCII 0x3E)

> Set commands and Get responses always end with “=” (ASCII 0x3D) followed by the para-

meter value

> Numerical values are entered as simple ASCII text without the units (e.g. -28dB is simply

entered as “-28”)

> Multiple commands sent on a single line are separated by a semi-colon (ASCII 0x3B)

> All commands are terminated with a <CR> (Carriage Return – ASCII 0x0D)

> Devices respond with ‘ACK’ (ASCII 0x06) if successful or ‘NAK nn’ if unsuccessful where nn

is a 2-digit error code

PRO.BOSE.COM 4 OF 84

Subscription Commands:

Subscription is used to obtain current value without the need to solicit data periodically. As value
changes, new value will be sent if being subscribed.

> Command should be capital letters

> All commands are terminated with a <CR> (Carriage Return – ASCII 0x0D)

Endpoint Commands:

> Numerical values for Module Commands are entered as basic ASCII text. For example, -

15dB would be entered as “-15.0”

> Commands should be capital letters

> Command may have 1 or 2 parameters separated by <SPACE> (ASCII 0x20)

> Numerical values are entered as simple ASCII text without the units (e.g. -15dB is simply

entered as “-15.0”)

> All commands are terminated with a <CR> (Carriage Return – ASCII 0x0D)

> Devices respond with “ACK” and an echo of received command if successful or “NACK” if

unsuccessful. Note that these are text strings and not the ASCII <ACK> and <NAK> char­acters used in the Module Commands.

PRO.BOSE.COM 5 OF 84

4 System Commands

System commands are used to invoke changes across multiple devices simultaneously and use con­structs programmed via ControlSpace Designer software (such as Parameter Sets and Groups). Com­mands issued to the designated ‘RTC/Main’ device will be echoed to all other devices on the network
(assuming they are correctly connected to the same network). Otherwise, commands should be issued
to one of the devices involved in the construct being controlled (e.g. if a Group spans two ESPs, then
the Group command should only be issued to one of those two devices, not to others).

System commands use hexadecimal notation for numerical values and only ‘Get’ commands generate
a response. Following a ‘Set’ command with a ‘Get’ is a useful way to confirm command success.

4.1 Set/Get Parameter Set (SS, GS)

4.2 Set/Get Group Volume Master Level (SG, GG)

4.3 Set Group Volume Increment/Decrement (SH)

4.4 Set/Get Group Volume Master Mute (SN, GN)

4.5 Set/Get Room Combine (SRC, GRC)

4.6 Set/Get Parameter Set Lists (GA, SA)

4.1 Set/Get Parameter Set (SS, GS)

To recall or invoke Parameter Setn:

SSn<CR> where

n

is the Parameter Set number, 1 – FFh (1–255 decimal)

To query for the last invoked Parameter Set:

GS<CR>

Response:

Sn<CR> where

EXAMPLES:

SS b<CR> Recall Parameter Set 11 (hex = b)
GS<CR> Query for last invoked Parameter Set

S 5<CR> Response indicating Parameter Set 5 was invoked last

n

= 0 – FF (n = 0 if no Parameter Set recalled, e.g. after power-up)

4.2 Set/Get Group Master Level (SG, GG)

Groups of ESP inputs, outputs or gain blocks have a range of -60dB to +12dB, whereas PowerMatch
and PowerShare Amplifier outputs do not have gain and therefore have a maximum level of 0dB
(78h).

To set the master level of Groupnto levell:

SG

n,l

<CR> where

n

is the Group number, 1 – 40h (1-64 decimal)

l

is the level, 0h (-60dB) to 90h (+12dB) in 0.5dB steps (0-144 dec)
or PM and PS, 0h (-60dB) to 78h (0dB) in 0.5dB steps (0-120 dec)
FFh (-60.5dB/-∞) on all devices (255 dec)

To set the source selector channel of Groupnto channell:

SG

n,l

<CR> where

PRO.BOSE.COM 6 OF 84

n

is the Group number, 1 – 40h (1-64 decimal)

l

is the channel to select, 1 – 20h (1-32 decimal)

To query the level of Group

GGn<CR> where

Response:

GG

n,l

where

n

n

is the Group number, 1 – 40h (1-64 decimal)

n,l

are the same as above.

To query the source selector channel of Group

GGn<CR> where

Response:

GG

n,l

EXAMPLES:

SG 2,78<CR> Set level for Group 2 to 0dB
GG 2<CR> Query the level for Group 2

GG 2,80<CR> Response indicating Group 2 is set to 1dB

where

n

is the Group number, 1 – 40h (1-64 decimal)

n,l

are the same as above.

n

4.3 Set Group Level Increment/Decrement (SH)

To increment (or decrement) the master level of Groupnbyxnumber of 0.5dB steps:

SH

n,d,x

<CR> where

EXAMPLES:

SH 2,1,6<CR> Increase the level of Group 2 by 3dB
SH 7,0,3<CR> Decrease the level of Group 7 by 1.5dB

n

is the Group number, 1 – 40h (1-64 decimal)

d

is the direction, 1=up or 0=down

x

is the number of 0.5dB steps in hexadecimal (e.g. 5dB = A)

4.4 Set/Get Group Master Mute (SN, GN)

To set or change the Mute state for Groupn:

SN

n,m

<CR> where

To query the Mute state of Groupn:

GNn<CR> where

Response:

GN

n,m

EXAMPLES:

SN 4,M<CR> Engage Mute for Group 4
GN 4<CR> Query the Mute status for Group 4

GN 4,M<CR> Response indicating Group 4 is Muted

where

n

is the Group number, 1 – 40h (1-64 decimal)

m

is the state, M = Mute, U = Un-mute, T = Toggle mute state

n

is the Group number, 1 – 40h (1-64 decimal)

n,m

are the same as above.

4.5 Set/Get Room Combine (SRC, GRC) [EX Only]

Room Combine Groups allow several rooms to be organized and managed together using Conference
Room Router modules. Once the Conference Room Router module for each of the rooms has been
added to a Room Combine Group it becomes possible to join or split rooms in different combinations,

PRO.BOSE.COM 7 OF 84

routing the audio between them and linking their master volume controls together. This is typically
used for adaptable conference rooms where dividing partitions can be added to split rooms or
removed to combine several smaller rooms into one large room.

These commands are used to join or split pairs of rooms within a given Room Combine Group, much
like the physical partitions. Rooms can be referenced by their number or name. Both of which are
defined in the Room Combine Group configuration panel.

To join two rooms together using room numbers:

SRC

n,a,b,s

To join two rooms together using room names:

SRC

"N","A","B",s

To query whether two rooms are joined using room numbers:

GRC

n,a,b

Response:

GRC

n,a,b,s

<CR> where

<CR> where

<CR> where

<CR> where

n

is the Room Combine Group number, 1-6

a,b

are the room numbers, 1-6

s

is the state, J = Join and S = Split

N

is the Room Combine Group name

A,B

are the room names

s

is the state, J = Join and S = Split

n

is the Room Combine Group number, 1-6

a,b

are the room numbers, 1-6

n

is the Room Combine Group number, 1-6

a,b

are the room numbers, 1-6

s

is the state, J = Join and S = Split

To query whether two rooms are joined using room names:

GRC

n,"A","B"

Response:

GRC

n,”A”,”B”,s

To query which rooms are currently joined:

GRCn<CR> where

Response:

GRC

n,[a,b][c,d,f]

EXAMPLES:

SRC 2,"Victory","Trafalgar",J<CR>

SRC 1,2,4,S<CR> Split rooms 2 and 4 in Room Combine Group 1

GRC "Ground Floor"<CR>

GRC "Ground Floor",[2,4,5][1,3]<CR>

<CR> where

<CR> where

<CR> where

n

is the Room Combine Group number, 1-6

A,B

are the room names

n

is the Room Combine Group number, 1-6

A,B

are the room names

s

is the state, J = Join and S = Split

n

is the Room Combine Group number (or name)

n

is the Room Combine Group number

a-f

are the room numbers and the brackets “[]” indicate which

rooms are joined

Join rooms named “Victory” and “Trafalgar” from RC Group
2

Query for currently joined rooms in the “Ground Floor” RC
Group

Response indicating rooms 2,4 and 5 are joined, and rooms
1 and 3 are joined

PRO.BOSE.COM 8 OF 84

4.6 Set/Get Parameter Set Lists (SA, GA)

Parameter Set Lists are logical groupings of Parameter Sets. These commands are used to query for or
change the currently selected Parameter Set in a Parameter Set List and to query the last recalled Para­meter Set.

To query for the current selection of a Parameter Set List:

GA

"A"

>2 <CR> whereAis the Parameter Set List’s name

Response:

GA

“A”

>2=n<CR> whereAis the Parameter Set List’s name

n

is the index of the current selection

or

<NAK>

or

<NAK>

To change the current selection of a Parameter Set List:

SA

Response:

<ACK>

or

<NAK>

or

<NAK>

or

<NAK>

01 A

02

"A"

>1=n<CR> whereAis the Parameter Set List’s name

01 A

not recognized as valid Parameter Set List name

number after ‘>’ not 1 or 2

n

is index of the Parameter Set in the list to select

Selection set to nearest possible selection
(1 ifn= 0, max selection ifngreater than max selection, otherwisen)

not recognized as valid Parameter Set List name

number between ‘>’ and ‘=’ not 1 or 2

02

n

set to a negative value

03

PRO.BOSE.COM 9 OF 84

5 Device Commands

Device commands should be issued directly to the relevant ControlSpace device and will invoke
changes locally within that device. Device commands use hexadecimal notation for numerical values
and generally only ‘Get’ commands generate a response. Following a ‘Set’ command with a ‘Get’ is a
useful way to confirm successful execution.

5.1 Set/Get Input/Output Volume (SV, GV)

5.2 Set Volume Increment/Decrement (SI)

5.3 Set/Get Input/Output Mute (SM, GM)

5.4 Get Signal Level (GL)

5.5 Set/Get IP Address (IP)

5.6 Network Parameters (NP)

5.7 Reset/Reboot Device (RESET)

5.8 Set/Get Standby Status (SY, GY) [PowerMatch and PowerShare Only]

5.9 Get Configuration (GC) [PowerMatch Only]

5.10 Set/Get Fault Status (SF, GF) [PowerMatch Only]

5.11 Clear Fault/Alarms (CF) [PowerMatch Only]

5.12 Set/Get Alarm Reporting/Status (SR, GR) [PowerMatch Only]

5.13 Get/Clear Alarm History/Log (GH, CH) [PowerMatch and PowerShare Only]

The Volume (SV, GV, SI) and Mute (SM, GM) commands allow control of input/output levels and
mutes directly, referenced by a slot and channel number per the physical architecture of the device,
rather than by Module name. Whilst these commands are still currently supported it is recommended
that Module commands (SA, GA) be used to control the input and output modules for new projects.

The ESP-00 has 8 audio card slots and each card can support up to 8 channels, although many cards
only have 4 channels and do not use channels 5-8. These commands are not supported on Surround
decoder, Dante and CobraNet cards.

The ESP-880/1240/4120/1600, EX, PowerMatch and PowerShare devices have a fixed architecture but
still allow channels to be referenced using pseudo ‘slot’ numbers as described in Table 1 and Table 2.

PRO.BOSE.COM 10 OF 84

Slot

ESP-00ESP-

880

ESP-

880A

ESP-

880AD

ESP­1240

ESP-

1240A

Table 1

ESP-

1240AD

ESP­4120

ESP-

1600

EX-

1280C

EX-

440C

EX-

12AEC

EX-

1280

1

2 Out 1-4 Out 1-4 Out 1-4 Out 1-4 Out 1-4 Out 1-4 Out 1-4 In 5-8 Out 5-8 Out 5-8

3 I n 5-8 In 5-8 In 5-8 In 5-8 In 5-8 In 5-8 Out 5-8 In 9-12 In 1-4 In 1-4 In 1-4

4 Out 5-8 Out 5-8 Out 5-8 In 9-12 In 9-12 In 9-12 Out 9-12 In 13-16 In 5-8 In 5-8

5

Flexible

6

7

8

9

A USB USB USB

In 1-4 In 1-4 In 1-4 In 1-4 In 1-4 In 1-4 In 1-4 In 1-4 Out 1-4 Out 1-4 Out 1-4

ESPLink

Out 1-8

AmpLink

Out 1-8

AmpLink

Out 1-8

Dante

In/Out

1-32

ESPLink

Out 1-8

AmpLink

Out 1-8

AmpLink

Out 1-8

Dante

In/Out

1-32

ESPLink

Out 1-8

ESPLink

Out 1-8

In 9-12 In 9-12

AmpLink

Out 1-8

Dante

In/Out

In/Out

VoIP

In/Out

1-64

AEC

1-12

1-2

AmpLink

Out 1-4

Dante

In/Out

1-16

AEC

In/Out

1-8

VoIP

In/Out 1

Dante

In/Out

1-16

AEC

In/Out

1-12

AmpLink

Out 1-8

Dante

In/Out

1-64

B PSTN PSTN

Slot PM8xxxN PM4xxxN PSx04D

1 In A-D In A-D In 1-4

2 Out 1-4 Out 1-4 Out 1-4

3 In E-H

4 Out 5-8

Table 2

Note:

For 8ch PowerMatch and PowerShare devices the Get Signal Level (GL) command only uses Slot 1

(for Inputs) and Slot 2 (for Outputs) for all 8 channels.

5.1 Set/Get Input/Output Volume (SV, GV)

Input and output volume levels are referenced by slot and channel numbers per the physical archi­tecture of the device (refer to Table 1 at the start of this section). PowerMatch and PowerShare devices
only support volume control of the outputs, not the inputs.

Note:

To set the input/output volume of slots, channelc, to levell:

Set Volume commands will be ignored if the channel is muted.

SV

s,c,l

<CR> where

s

is the slot number (refer to Table 1 at the start of this section)

c

is the channel number, 1 – 8 (for ESP), 1 - 4 (for PM and PS)

l

is the level, 0h(-60dB) to 90h(+12dB) in 0.5dB steps (0-144 dec)

or PM and PS 0h(-60dB) to 78h(0dB) in 0.5dB steps (0-120 dec)

PRO.BOSE.COM 11 OF 84

To query the input/output level of slots, channelc:

GV

s,c

<CR> where

Response:

GV

s,c,l

EXAMPLES:

SV 1,3,50<CR> Set volume for slot 1, channel 3 to -20dB
GV 2,1<CR> Query the volume level for slot 2, channel 1

GV 2,1,78<CR> Response indicating the level for slot 2 channel 1 is set to 0dB

where where

s

is the slot number, (refer to Table 1 at the start of this section)

c

is the channel number, 1 – 8 (for ESP), 1 - 4 (for PM and PS)

s,c,l

are the same as above

5.2Set Volume Increment/Decrement (SI)

Input and output volume levels are referenced by slot and channel numbers per the physical archi­tecture of the device (refer to Table 1 at the start of this section). PowerMatch and PowerShare devices
only support volume control of the outputs, not the inputs.

Note:

To increment (or decrement) the level of slots, channelc:

EXAMPLES:

Set Volume Increment/Decrement commands will be ignored if the channel is muted.

SI

s,c,d,x

SI 2,3,1,6<CR> Increase the level of slot 2, channel 3 by 3dB
SI 4,1,0,3<CR> Decrease the level of slot 4, channel 1 by 1.5dB

<CR> where

s

is the slot number (refer to Table 1 at the start of this section)

c

is the channel number, 1 – 8 (for ESP), 1 - 4 (for PM and PS)

d

is the direction, 1=up or 0=down

x

is the number of 0.5dB steps in hexadecimal (e.g. 5dB = A)

5.3Set/Get Input/Output Mute (SM, GM)

Input and output volume levels are referenced by slot and channel numbers per the physical archi­tecture of the device (refer to Table 1 at the start of this section). PowerMatch and PowerShare devices
only support volume control of the outputs, not the inputs.

To set or change the Mute status for slots, channelc:

SM

s,c,m

<CR> where

s

is the slot number (refer to Table 1 at the start of this section)

c

is the channel number, 1 – 8 (for ESP), 1 - 4 (for PM and PS)

m

is the state, M = Mute, U = Un-mute, T = Toggle mute state

To query the Mute status for slot s, channel c:

GM

s,c

<CR> where

Response:

GM

s,c,m

EXAMPLES:

SM 2,1,M<CR> Engage Mute for slot 2, channel 1
GM 3,2<CR> Query the Mute status for slot 3, channel 2

GM 3,2,U<CR> Response indicating slot 3, channel 2 is un-muted

PRO.BOSE.COM 12 OF 84

where

s

is the slot number, (refer to Table 1 at the start of this section)

c

is the channel number, 1 – 8 (for ESP), 1 - 4 (for PM and PS)

s,c,m

are the same as above

5.4 Get Signal Level (GL)

This command can be used the query the current signal levels for inputs, outputs, and AEC on pro­cessors and amplifiers.

The GL command returns an array of channel levels in hexadecimal. The level must be converted to
the appropriate unit for the queried device and channel type by first converting the level to decimal
and then applying the following formula, unless otherwise noted.

l All analog input, digital input, and digital output levels are represented as dBFS from -60.0dBFS

to 0.0dBFS in 0.5dB steps.

l Fixed I/O ESP and EX analog output levels are represented as dBu from -35.0dBu to 25.0dBu in

0.5dB steps.

l ESP-00 analog output levels are represented as dBu from -36.0dBu to 24.0dBu in 0.5dB steps.

l PowerMatch and PowerShare analog output levels are represented as dBV max from -60.0dBV

to 0.0dBV in 0.5dB steps. For a mono channel, Vmax = 71V = 0dBV. For a bridged/quad chan­nel, Vmax = 141V = 0dBV.

l EX processors with an AEC module provide three different levels – input, ERL, and ERLE.

- Input levels are represented as dBFS from -60.0dBFS to 0.0dBFS in 0.5dB steps.

- ERL levels are represented as dB from -60.0dB to +20.0dB in 0.5dB steps.

- ERLE levels are represented as dB from -60.0dB to 0.0dB in 0.5dB steps.

To query the current signal level for channels in slot s:

Request:

GLs<CR> wheresis the slot index (refer to GL Indices)

Response:

GL

s [1,…,N]

<CR> wheresis the slot index (refer to GL Indices) and

1…N

are the current signal levels

for channels 1 to N.

PRO.BOSE.COM 13 OF 84

To query the current signal levels for parameters p in slot s:

Request:

GL

s,p

<CR> wheresis the slot index andpis the parameter index (refer to GL Indices)

Response:

GL

s,p [1,…,N]

<CR> wheresis the slot index,pis the parameter index (refer to GL Indices), and

1…N

are the current signal levels for channels 1 to N.

EXAMPLES:

GL 1<CR> Request ESP analog input levels for channels 1-4 (Slot 1)

GL 1 [78,1,40,64]<CR>

Response indicating ESP input levels are 0.0, -59.5, -28.0, and

-10.0dBFS

GL 2<CR> Request PowerMatch output levels for channels 1-8 (Slot 2)

GL 2 [0,0,0,0,0,0,64,64]<CR>

Response indicating PowerMatch output level is -10.0dBV max
on channels 7 and 8

GL 8,3<CR> Request AEC ERLE levels (Slot 8, Parameter 3)

GL 8,3 [28,0,0,0,0,0,0,0,0,0,0,0]<CR> Response indicating AEC ERLE level for channel 1 is -40.0dB

GL Indices

ESP-

ESP-

ESP-

ESP-

ESP-

Module

In 1-4

In 5-8

In 9-12

In 13-16

Out 1-4

Out 5-8

Out 9-12

ESPLink

AmpLink

Dante

VoIP

USB

PSTN

AEC

(Input)

AEC

(ERL)

AEC

(ERLE)

00 II

Slot

Index

880

880A

880AD

1 1 1 1 1 1 1 1 3 3 3 1 1 1

3 3 3 2 2 2 2 4 4 1

2 2 2 4 4 4 2 1 1 1 2 2 2

4 4 4 3 2 2 2

5 5 5 5

5 5 5 5 6 6 6

6 6 7 7 7 7

ESP-

1240

1240A

3 3 3 3 5 5

ESP-

1240AD

ESP­1600

4

ESP­4120 EX-12AEC

4

8,1 8,1 8,1

8,2 8,2 8,2

8,3 8,3 8,3

EX-

EX-

440C

1280

9 9

A A A

B B

EX-

1280C

PM4250N

PM4500

PM8250N

PM8500N

PS404D
PS604D

PRO.BOSE.COM 14 OF 84

5.5Set/Get IP Address (IP)

The Set and Get IP address commands provide an alternative method for querying and changing the
IP address of ControlSpace Devices when the Hardware Manager in ControlSpace Designer software is
unavailable. This can be particularly useful when the network settings for an ESP (which does not have
a front panel display) are unknown, but you do have access to the RS232 serial port.

To query the current IP address for the device:

IP<CR>

Response:

IP xxx.xxx.xxx.xxx <CR>

To set or change the IP address for the device:

IP xxx.xxx.xxx.xxx <CR>

EXAMPLES:

IP<CR> Query the current IP address for the device

IP 192.168.0.160<CR> Response indicating an IP address of 192.168.0.160 is set

IP 192.168.1.160<CR> Command changing the IP address to 192.168.1.160 (after boot)

Note:

device has been re-booted.

When using the IP command to change IP address, the changes do not take effect until after the

5.6Network Parameters (NP)

The Network Parameter command allows additional network settings such as; Subnet Mask, Default
Gateway and DHCP mode to be set or queried. There is also a command to return all network settings
(including the IP address) to their default network settings. This can be particularly useful when the net­work settings for an ESP (which does not have a front panel display) are unknown, but you do have
access to the RS232 serial port.

To query a specific network setting for the device:

p

NPp<CR> where

Response:

NP

p,v

<CR> where

To set a specific network setting for the device:

NP

p,v

<CR> where

is the network parameter to query, T = Type (DHCP or Static, not avail-

able for ESP-00),

M = Subnet Mask, G = Default Gateway

p

is the is the network parameter queried

v

is the value, D = DHCP or S = Static IP for Type <or>

xxx.xxx.xxx.xxx address for Subnet Mask and Default Gateway

p

is the network parameter to set, T = Type (DHCP or Static),

M = Subnet Mask, G = Default Gateway

v

is the value, D = DHCP or S = Static IP for Type <or>

xxx.xxx.xxx.xxx address for Subnet Mask and Default Gateway

To reset all network parameters for the device to defaults:

NP F<CR>

PRO.BOSE.COM 15 OF 84

Note:

or restarted using the ‘RESET<CR>’ command.

EXAMPLES:

Any changes to network parameters do not take effect until after the device has been re-booted

NP M<CR> Query the current Subnet Mask for the device

NP M,255.255.255.0<CR> Response indicating a Subnet Mask of 255.255.255.0

NP M,255.255.255.128<CR> Command to change Mask to 255.255.255.128 (after reboot)
NP G,192.168.0.2<CR> Command to change Gateway to 192.168.0.2 (after reboot)
NP T<CR> Query the current networking mode for the device

NP T,D<CR> Response indicating device is currently set to DHCP

NP T,S<CR> Command for device to change to static IP addresses
NP F<CR> Command to reset network settings to defaults

Default Network Settings

Device Mode IP Address Default Gateway

ESP-00/88 Static 192.168.0.16/24 192.168.0.1/24

ESP-880/880A/880AD

ESP-1240/1240A/1240AD

ESP-1600/4120

EX-12AEC/440C/1280/1280C

PM4250N/4500N/8250N/8500N

PS404D/604D

Note:

nection only. The VoIP settings remain unaffected.

For the EX processor, resetting all network parameters to their defaults applies to the control con-

DHCP 169.254.0.0/16 N/A

5.7Reset/Reboot Device (RESET)

The Reset command instructs a device to restart (the equivalent of power-cycling or rebooting). This
can be useful when making IP address or Network Parameter changes remotely since the changes only
take effect after the device has been rebooted.

When connected via RS232, an ESP will send a “Ready” string once the boot process is completed,
whereas serial-over-Ethernet connections will need to be re-established once sufficient time has
elapsed. The time it takes for a device to boot varies depending on the device type and the installed
cards.

To reset/reboot a device:

RESET<CR>

Note:

and the device will revert to its power-on (flashed) settings.

Just like when the device is rebooted manually, all the current settings in the device will be lost

EXAMPLE:

RESET<CR> Request the device to restart/reboot

PRO.BOSE.COM 16 OF 84

5.8Set/Get Standby Status (SY, GY) [PowerMatch and PowerShare Only]

The Set and Get Standby Status commands allow the power state of an individual PowerMatch and
PowerShare amplifier to be controlled remotely. Since entering or exiting standby is not immediate,
adequate time should be allowed for the process to complete.

Alternatively, the power state can also be controlled via Parameter Set using the device’s ‘Standby’
property. This option allows multiple PowerMatch and PowerShare devices to be controlled together.

Note:

To set or change the standby state for a PowerMatch and PowerMatch amplifier:

To query the current standby state for the device:

EXAMPLES:

This command is not supported on ESP devices

SYs<CR> where

GY<CR> where

Response:

GYs<CR> where

SY S<CR> Put the PowerMatch and PowerShare device into standby mode
GY<CR> Query the current standby state

GY N<CR>

s

is the state, S = Standby, N = Normal

s

is the slot number, (refer to Table 1 at the start of this section)

s

is the state, S = Standby, N = Normal

Response indicating PowerMatch and PowerShare device is in Normal
state (On)

5.9Get Configuration (GC) [PowerMatch Only]

The Get Configuration (GC) command returns the current output configuration of a PowerMatch amp­lifier. Knowledge of the output configuration can be useful when using the module (SA/GA) com­mands to change parameters.

To query the current output configuration

GC<CR>

Response:

1-8

GC

1,2,3,4,5,6,7,8

EXAMPLES:

GC <CR> Query the current output configuration

GC IN,IN,BL,BL,Q7,Q7,Q7,Q7<CR>

<CR> where

is the configured state for each channel of the Amplifier (1-4
for PM4250N/PM4500N): IN= Independent (Mono), BL =
Bridged (LoZ), B7 = Bridged (70v), B1 = Bridged (100v), PA =
Parallel, QL = Quad (LoZ), Q7 = Quad (70v), Q1 = Quad (100v)

Response indicating channels 1&2 are Independent, 3&4 are
Bridged (Lo-Z) and 5-8 are in Quad (70v) mode

5.10 Set/Get Fault Status (SF, GF) [PowerMatch Only]

The Get Fault Status (GF) command queries the current state of the Fault Output on a PowerMatch
amplifier. The Set Fault status (SF) command enables or disables unsolicited transmission of changes
to the Fault Output state. The format of the unsolicited message is the same as the response to the Get
Fault status (GF) command.

Note:

time the amplifier is powered up.

The Set Fault status (SF) preference is not retained on power down and will default to ‘Off’ each

PRO.BOSE.COM 17 OF 84

To set (enable or disable) unsolicited notification of Fault Output state changes:

SFn<CR> where

To query the current Fault status:

GF<CR>

Response:

n

is the notification state, O = On, F = Off

GFf<CR> where

EXAMPLES:

SF O<CR> Enable unsolicited output of Fault Output state changes
GF<CR> Query the current status of the Fault Output

GF F<CR>

f

is the current Fault status, F= Fault, C = No Fault

Response indicating that the PowerMatch device is currently in a fault
state

5.11Clear Fault/Alarms (CF) [PowerMatch Only]

The Clear Fault/Alarms (CF) command clears any currently active alarm conditions, and resets the
Fault Output on a PowerMatch device. Note that if any alarm or fault conditions are still present after
the reset, the alarm status and Fault output will be automatically set again.

To clear currently active alarm conditions/Fault output:

CF<CR>

Response:

<ACK><CR>

EXAMPLES:

CF<CR> Command to clear active alarms/reset fault state

<ACK><CR> Response indicating action was successful

5.12 Set/Get Alarm Reporting/Status (SR, GR) [PowerMatch Only]

The Get Alarm Reporting (GR) command queries the current alarm/fault status for a channel of a
PowerMatch amplifier, whilst the Set Alarm Reporting (SR) command enables or disables unsolicited
transmission of alarm and fault events when they occur. The format of the unsolicited message is the
same as the response to the Get Alarm Status (GR) command.

Note:

each time the amplifier is powered up.

To set (enable or disable) unsolicited notification of alarm/fault notifications:

The Set Alarm Reporting (SR) preference is not retained on power down and will default to ‘Off’

SRn<CR> wherenis the notification state, O = On, F = Off

PRO.BOSE.COM 18 OF 84

Unsolicited notification
format:

c

GR

c,s,t,x

To query the current alarm status for a single channel:

GRc<CR> wherecis the channel number, 1 – 8 (1 – 4 for PM4500N/PM4250N)

Response:

GR

c,s,t

<CR> where

<CR> where

is the channel number, 1 – 8 (or 0 for non-channel specific alarms such

as Digital Audio Loss or AC Mains Loss)

s

is the severity; W=Warning, F=Fault, S= System

t

is the alarm type; N=No Alarm, O=Open, S=Short, A=ACLoss, D=Digital
Audio Loss, I=I-Share Jumper Missing, L=Limiting, C=Clip (Input), P=Pr­rotection, Z = Other

x

is the condition; S=Set, C=Clear (not used for all alarms/faults)

c

is the channel number, 1 – 8

s

is the severity; W= Warning, F=Fault, S= System, N=No Alarm

t

is the alarm type; N=None, O=Open, S=Short, I=I-Share Jumper Missing,

Z = Other

Note:

returned.

The transient nature of alarms such as limiting or clipping means they cannot be queried manually. To
receive such alarms, turn on automatic notification. Only the first instance of limiting or clipping for a
given channel is reported, so for continued monitoring alarms should be cleared after each notification.

EXAMPLES:

If multiple alarms/faults exist for the same channel, the one with the highest severity will be

SR O<CR> Enable unsolicited notification of Alarm/Fault conditions

GR 5,F,I,S<CR> Unsolicited notification that the I share jumper is missing for channels 5 & 6
GR 6,F,I,S<CR>

GR 4<CR> Query the current alarm/fault status for channel 4

GR 4,F,S<CR> Response indicating that ch4 has a ‘SHORT’ fault condition

5.13 Get/Clear Alarm History/Log (GH, CH) [PowerMatch, PowerShare Only]

The Get Alarm History (GH) command requests a dump of the internal alarm history/log to the serial
output, whilst the Clear Alarm History (CH) command causes the internal alarm log to be cleared.

Note:

trolSpace Designer software. Actual time/date values will only be returned if there has been no loss in
power since last connected to ControlSpace Designer software. Otherwise, relative values since last
power-up will be returned.

The alarm log is returned in a similar format to the front panel display or the alarm panel in Con-

PRO.BOSE.COM 19 OF 84

To query/request the alarm log:

GH<CR>

Response:

GH [Time, Date, Description<CR>

Time, Date, Description<CR>

……

Time, Date, Description]<CR>

To clear the internal alarm history/log

CH<CR>

Response:

<ACK><CR>

EXAMPLES:

CH<CR> Request Alarm log be cleared

<ACK><CR> Response indicating command was successful

PRO.BOSE.COM 20 OF 84

6 Module Commands

Module commands allow control of parameters for a specific signal processing module on a specific
device.

Set/Get Module Parameter (SA, GA), Invoke Module Action (MA)

The Set and Get Module Parameter commands provide access to virtually any parameter from any sig­nal processing module of any ControlSpace device. Devices and Modules are referenced by their label
assigned via ControlSpace Designer software. Unlike the ESP and EX devices where most signal pro­cessing module labels are user-definable, only the Input and Amp Output modules can be renamed on
PowerMatch and PowerShare devices.

Note: Module labels must be unique. If two modules within the same device have the same name. then
the SA, GA and MA commands will not work correctly. For example; if an Output module and a PEQ
module are both named “Left” neither module will respond correctly.

In combination with the module label, the parameter to change or query is identified using 1, 2 or (for a
few modules only) 3 indices. These indices are unique to each type of module and are detailed at the
end of this section.

Automatic notification (#Module Name)

In additional to querying the parameters for each module, it is also possible to
receive automatic notifications when a module’s parameters change by pre­fixing the module name with “#” in ControlSpace Designer software. For
example, by renaming module “Hall” to “#Hall”, a GA (Get Module Parameter)
response will be issued over the serial connection when any of the parameters
for that module are changed by other devices in the system, such as CC-16 or
CC-64 user interfaces.

Note:

To set or change a module parameter (SA):

A response will not be sent if the change is made via serial command.

SA "Module Name">Index 1>Index 2=Value<CR>

where "Module Name" is a unique Label set using Designer software

> ‘greater than’ (ASCII 0x3E) is the separator between indices
Index 1 Index 1 is the primary index (all modules)
Index 2 Index 2 is a secondary index (some modules)
= ‘equals’ (ASCII 0x3D) indicates Value follows
Value Value of parameter referenced by Module/Indices

Response:

<ACK> if command is successful (ASCII 0x06)

or

<NAK>

nn

if command is received but unsuccessful (ASCII 0x15),

where

nn

is a 2-digit error code, detailed in the following table:

PRO.BOSE.COM 21 OF 84

Code Error

01 Invalid Module Name (no match found for module name – or duplicate name)

02 Illegal Index (index value or quantity incorrect for specified module)

03 Value is out-of-range (value is not permitted for the specified parameter)

99 Unknown error

To query a module parameter (GA):

GA "Module Name">Index 1>Index 2<CR>

where "Module Name" is a unique Label set using Designer software

> ‘greater than’ (ASCII 0x3E) is the separator between indices
Index 1 Index 1 is the primary index (all modules)
Index 2 Index 2 is a secondary index (some modules)

Response:

GA "Module Name">Index 1>Index 2>=Value<CR>

For ESP processors, it is possible to send a Module command to a different device than the one on
which the module resides, provided the ESPs are correctly networked together. This facility is not avail­able for PowerMatch amplifiers so commands should be sent to each device individually.

To set or change a module parameter on a different Device (SA):

SA @ "Device Name" "Module Name">Index 1>Index 2=Value<CR>

where @ ‘at’ (ASCII 0x40) identifies that the command is for a different device

"Device Name" is the unique device label from ControlSpace Designer

Response:

<ACK> if command is successful (ASCII 0x06)

or

<NAK>

To query a module parameter on a different Device (GA):

GA @ "Device Name" "Module Name">Index 1>Index 2 <CR>

Response:

GA "Module Name">Index 1>Index 2>=Value<CR>

There are a few modules (e.g. PSTN Input or VoIP Input) that, in additional to having parameters that
can be adjusted, also have actions that can be invoked (e.g. Make Call) using the Module Action (MA)
command.

To invoke an action for a module (MA): (Only supported on a limited number of modules)

nn

if command is received but unsuccessful (ASCII 0x15),

where

where @ ‘at’ (ASCII 0x40) identifies that the command is for a different device

"Device Name" is the unique device label from ControlSpace Designer

nn

is a 2-digit error code – same as above

PRO.BOSE.COM 22 OF 84