Symetrix Composer v7.0 User manual

Composer v7.0
Control Protocol
www.symetrix.co | T+1.425.778.7728

Table of Contents
Contents
Introduction 3
About This Document 3
Conventions Used In This Document 3
General Notes 3-4
Connections 3
RS-232 Port Configuration 3
Ethernet Port Configuration 3
Ethernet Control 3
RS-485 Control 4
Site Identifier 4
Parameter Notes 5-7
Faders 5
Faders with User Min and User Max Limits 5
Buttons 6
Input and Output Selectors 6
Meters 6
LEDs 6
Other Parameters 6
Diagnostic Controls 6
Parameters That Cannot Be Controlled Externally 7
Getting Started 7
Protocol 7
Control Commands 7-13
(CS) Controller Set 7
(CSQ) Controller Set Quick 8
(CC) Change Controller 8
(GS) Get Controller 8
(GS2) Get Controller with Controller Number 9
(GPR) Get Preset 9
(GSB) Get Controller Block 9
(GSB2) Get Controller Block with Controller Number 10
(GSB3) Get Controller Block with Controller Number 10
(LP) Load Preset 11
(FU) Flash Unit LEDs 11
(SSYSS) Set System String 11
Dialing VoIP Strings 12
(GSYSS) Get System String 12
Pushing GSYSS String Values 13
Push Commands 13-15
Commands Related to Push 15-18
(PU) Global Push Enable/Disable 15
(PUE) Push Enable 16
(PUD) Push Disable 16
(GPU) Get Push-enabled Controllers 16
(PUR) Push Refresh 17
(PUC) Push Clear 17
(PUI) Set Push Interval 18
(PUT) Set Push Threshold 18
Setup Commands 19
(SB) Set Baud 19
(SQ) Set Quiet Mode 19
(EH) Set Echo Mode 19
System Commands 20
(NOP) No operation 20
(Q!) Quit TCP/IP session 20
(RI) IP address 20
(V) Version 20
(R!) Reboot 20
Special Command Prefixes 21
($e) Echo Mode 21
($v) Verbose Mode 21
($q) Quiet Mode 21
Super Matrix Mixer Control Protocol 21-24
Background 21
Features to Control 21
Commands 21
Basic Examples 22
Range Examples 23
Return Value 23
Polling for Changes 24
2 25
of
www.symetrix.co | T+1.425.778.7728

Introduction and General Notes
Introduction
About This Document
The purpose of this document is to introduce the Symetrix
Control Protocol for Composer. This document defines and
illustrates the protocol used to communicate with Edge,
Radius, Radius AEC, xControl, or other compatible Symetrix
units via a third-party control interface using RS-232, TCP/IP,
or UDP/IP.
Compatible units can be controlled by third-party controllers
such as AMX or Crestron models, or any RS-232 or Ethernet
equipped unit that can be adapted to the Composer control
protocol. The protocol consists of human-readable text
commands and responses.
Control is achieved by using a scheme of user-assigned
controller numbers. Nearly anything that can be adjusted
from the Composer control and configuration application
can be controlled externally by referencing the appropriate
controller numbers that are defined using Composer.
Conventions Used In This Document
Values enclosed in [square brackets] are optional parameters
and do not need to be included. If omitted, default values
will be used as described for each command.
The term “control application” is used to refer to Composer
software provided by Symetrix to configure and control
Symetrix units.
General Notes
Connections
Units are equipped with an Ethernet port and one or more RS-
232 ports. Either port may be used to control the unit. Ethernet
is generally preferred because of the simplified set-up and
higher data rates.
RS-232 Port Configuration
Connect your RS-232 based accessory remote to the
RS-232 port. For testing purposes, a terminal emulation
program such as HyperTerminal, TeraTerm, or puTTY can
be run on a PC instead. Typically this connection requires
a “straight through” cable, but a null-modem cable may be
required depending on the manufacturer. In general, if the
genders of the two connectors you are trying to connect
are the same, a “null modem” cable is required. Set up the
controller for baud: 57600, data bits: 8, stop bits: 1, parity:
NONE. No handshaking or flow control is used. The straight-
through pin out for a typical application is shown in the
following figure.
The commands Set Baud, Set Quiet Mode and Set Echo
affect the RS-232 port. Composer determines the start-up
values of these settings, though this can be changed during
a session. The unit’s default settings (Baud 57600, Quiet
Mode ON, Echo OFF) are typical for most applications.
These commands are documented for reference on page
18.
Ethernet Port Configuration
Generally, no special configuration is required for the
Ethernet port. The Ethernet port on the unit may be used
for both the Composer control application and for external
control.
Take note of the unit’s IP address (listed in the System
Manager), as you will need to send all commands to this
address.
The commands Set Quiet Mode and Set Echo affect the
Ethernet port. Composer determines the start-up values
of these settings, though this can be changed during a
session. The unit’s default settings (Quiet Mode ON, Echo
OFF) are typical for most applications.These commands are
documented for reference on page 18.
Ethernet Control
The Ethernet protocol uses the same RS-232 command
protocol over an Ethernet network. Both TCP/IP and
UDP can be used to control the system. TCP/IP control
functionality was added in Composer 3.0. TCP/IP control
does not use any of the options or escape sequences found
in Telnet. Up to six TCP/IP telnet sessions can be active at
one time (four with versions prior to Composer 6.0).
If a seventh TCP/IP connection is initiated, the least recently
used session will be automatically closed. Sessions may also
be closed manually with the Q! command described later in
this document.
Control systems should avoid closing and re-opening TCP
connections if possible. Keeping a single TCP session open
to send multiple commands through will result in much
better performance than opening and closing a session for
each command.
To control the system with Ethernet, command strings are
sent as the payload of a UDP/IP or a TCP packet. The
following rules should be observed in sending commands:
Pin 3Pin 1
Pin 2
Pin Signal
1 Ground
2 RX
3 TX
Terminal Block
Pin 5Pin 1
Pin 6 Pin 9
Control System (DB9 Male)
Symetrix (Terminal Block Female)
Pin Signal
1
2 TX
3 RX
4
5 Ground
6
7
8
9
DB9 Male
3 25
of
www.symetrix.co | T+1.425.778.7728

General Notes
• Commands should be sent to UDP or TCP port number 48631
of the Edge or Radius unit’s IP address. The IP address may be
found using the Connection Wizard or on some units’ front panel
displays.
• Commands should be formatted exactly as defined in this
document and include a carriage return that terminates the
command.
• Command strings may or may not include a zero termination
character.
• Commands should not be broken up across multiple packets.
• If high reliability communications are required, responses to
commands should be analyzed for success.
Responses to commands will exhibit the following behavior:
• Responses to each command issued are returned in a single
packet unless the response is larger than a single packet
can hold. Responses will not have any single carriage return-
terminated line broken up across packets unless there is no
carriage return in the data of the response.
• Responses are returned only to the IP address and source
port number that sent the packet. Other connections will see
responses if the particular control numbers are ‘push’ enabled.
• Responses follow the configuration of the port, just as if it were
an RS-232 port. For example, echo mode and quiet mode are
kept independently for the RS-232 port, the UDP port and the
TCP port.
• Responses do not include a zero-termination character.
• All transmissions originating from units will either be responses to
commands or pushed data.
Each command sent to a Symetrix unit contains information
in the Ethernet packet header as to who sent the command,
and hence, where a response will be sent. This source
information is saved when a packet is received by a Symetrix
unit. For UDP, all responses go to the last received IP
address and port and this IP address and port number are
saved in non-volatile memory across power cycles. For TCP,
the control system must re-initiate the TCP connection after
a power cycle.
Until the first command is received, responses will not know
where they are supposed to be sent. This normally is not an
issue as communication from the Symetrix unit is generally
a response to a command. However, if the Symetrix unit is
set up to push control data, it will also be pushed out the
TCP and UDP ports. If no valid packets have ever been
received by a Symetrix unit and no TCP/IP connections are
active, pushed data will not be sent out the Ethernet port. If
a Symetrix unit and a TCP connection is active, then pushed
data will be transmitted over TCP. If valid packets have been
received over UDP by a Symetrix unit, then pushed data will
be transmitted over UDP.
Pushing of data can be controlled independently for RS-232
and Ethernet ports.
Note: The RS-232 serial port and the Ethernet port are
essentially independent. They maintain separate settings
for quiet and echo modes. Commands sent to one port are
not echoed out the other, and responses are sent only to
the port from which the command was received. Hence, the
two ports will not necessarily send out the same data. One
exception to this is push data and strings, which are sent
out both RS-232 and Ethernet ports in parallel.
RS-485 Control
RS-485 control is generally done using one or more of the
Symetrix ARC (Adaptive Remote Controller) units. Further
discussion of RS-485 and the ARCs can be found on the
Symetrix web site.
Site Identifier
By default, any control data sent to a Symetrix unit (via
ARC, RS-232, UDP/IP, or TCP/IP) will be re-broadcast over
Ethernet by the unit that receives the command to all units
that are connected via Ethernet. This ensures that multiple
Symetrix units with the same Site Identifier that are using
the same control numbers will also receive and interpret the
command and respond to the command appropriately (i.e.,
adjust faders, button states, etc).
When the system consists of multiple independent site files
on the same network and you do not want control data
for common control numbers to be shared between these
different site files, each site file must have a unique site
identifier set in Composer. Unique Site Identifiers in the site
file inform other systems with different site identifiers on the
same network to ignore the re-broadcasted commands.
Using unique Site Identifiers for different site files on the
same network does not require any change in how the
systems are controlled from a third-party control system.
The third-party control system continues to send commands
to the Symetrix device to be controlled and that device
re-broadcasts that command along with the additional
information of the site identifier onto the network. Symetrix
units with Site Identifiers that are different from the site
identifier in the re-broadcasted command will simply ignore
the re-broadcasted command.
4 25
of
www.symetrix.co | T+1.425.778.7728

Parameter Notes
To set the identifier, within Composer, navigate to Tools >
Site Preferences and change the site identifier as shown in
the following figure.
Parameter Notes
Faders
Faders can be controlled to the limits of their minimum
and maximum values shown in the Design View screens in
Composer. A controller position of zero (0) will cause the
minimum fader position to be realized. A controller position
of 65535 will cause the maximum fader position to be
realized. Increasing positions will move the fader linearly in
dB.
Most volume faders have a range of -72dB to +12dB. In
these cases, the following formula can be used to convert
from controller position to dB:
Volume dB = -72 + 84*(CONTROLLER POSITION/65535)
If CONTROLLER POSITION = 0, Volume dB = OFF
For these faders, a value of 780 is approximately equal to a
1dB change in gain.
Note that some faders have a different range than –72 to
+12dB. In this case, the formula will depend upon the actual
fader range. The more general formula is shown below:
Volume dB = MINIMUM VALUE + (MAXIMUM VALUE – MINIMUM
VALUE)*(CONTROLLER POSITION/65535)
Where MINIMUM VALUE is the fader’s lower limit in dB and
MAXIMUM VALUE is the fader’s upper limit in dB.
Faders with User Min and User Max Limits
There are some applications where it is desired to limit the
range of adjustments for an end user, perhaps to allow a
more useable range of adjustment than the full range of the
fader or to prevent the system from getting too loud. To
limit the gain range of a fader to a user minimum and user
maximum range, the following formulae may be used.
In the following discussion, it is assumed that the range of
the variables (in dB) are as follows:
MAXIMUM VALUE ≥ User Maximum ≥ User Volume ≥ User
Minimum ≥ MINIMUM VALUE
The controller position is calculated the same as described
previously:
To determine the controller position based on a desired
User Volume in dB, then the controller value is calculated as
follows:
Controller Position = (User Volume in dB – MINIMUM VALUE) *
65535 / (MAXIMUM VALUE – MINIMUM VALUE )
The percentage value of the fader control relative to the User
Min and User Max values is computed as:
Volume Percent = (User Volume in dB – User Min) / (User Max –
User Min)
The controller position required to set the fader to a
percentage of the user min and user max may be computed
as follows:
Controller Position = (Volume Percent * (User Max – User Min)
+ (User Min – MINIMUM VALUE)) * 65535 / (MAXIMUM VALUE –
MINIMUM VALUE)
For example, if the Maximum and Minimum Values are +12
and -72, respectively, and the desired User Max and User
Min are +6 and -30 respectively, then the controller value for
setting the fader to -8dB is:
Controller Position = ((-8) – (-72))* 65535 / ((+12) – (-72)) =
49931
The controller position corresponding to 35% volume with
the same User Max and User Min range would be:
Controller Position = (35% * ((+6) - (-30)) + ((-30) - (-72))) *
65535 / ((+12) - (-72)) = 42598
5 25
of
www.symetrix.co | T+1.425.778.7728

Calculating the Volume in dB from the Volume Percentage
would be done as follows:
Volume in dB = (Volume Percent * (User Max – User Min)) + User Min
In this example, the volume in dB corresponding to 50% of
the volume would be calculated as:
Volume in dB = 50% * ((+6) – (-30)) + -30 = -12 dB
Buttons
Buttons such as a mute or bypass can be controlled
similarly with controller positions by sending the minimum
value (0) to turn the switch off (button not pushed) and
sending the maximum value (65535) to turn the switch on
(button pushed).
Input and Output Selectors
A value of zero (0) will select the first input or output and a
value of (65535) will select the last input or output. Other
values are selected by sending evenly spaced (linear) values
as shown by the formula below:
Controller Value = (INPUT NUMBER - 1)
*65535/(NUMBER OF INPUTS - 1)
Note: for an output selector, replace “INPUT” with
“OUTPUT” above.
Meters
Meters can be read via RS-232 or Ethernet. The read back
value will be linear in dB with 65535 representing +24 dBu (0
dBFS) and 0 representing -48 dBu (-72 dBFS) (or less). The
formula below can be used to calculate a dB reading from a
controller value:
Level dBu = 72*(CONTROLLER VALUE/65535) - 48
If CONTROLLER VALUE = 0, Level dBu <= -48 dBU
Input and output meters in some other modules such as
Compressors and AGCs can also be read. In this case, the
read back value will be linear in dB with 65535 representing
the maximum value shown on the meter and 0 representing
the minimum value shown on the meter (or less). The
formula below can be used to calculate a dB reading from a
controller value:
Level dB = (MAXIMUM VALUE - MINIMUM VALUE)
*(CONTROLLER VALUE/65535) + MINIMUM VALUE
If CONTROLLER VALUE = 0, Level dB <= MINIMUM VALUE
Where MINIMUM VALUE is the meter’s lower limit in dB and
MAXIMUM VALUE is the meter’s upper limit in dB.
Control meters in dedicated control meter modules can
also be read. In this case, the read back value will be linear
with 65535 representing 100% and 0 representing 0%.
The formula below can be used to calculate a percentage
reading from a controller value:
Level % = 100*(CONTROLLER VALUE/65535)
Note: Meters are a “read-only” parameter. Attempting to
change the meter value will have no effect.
LEDs
LEDs in various modules can be read via the control
protocol. The read back value will be either 65535 if the LED
is on or 0 if the LED is off.
Note: LEDs are a “read-only” parameter. Attempting to
change the LED value will have no effect.
Diagnostic Controls
Connected LED
The read back values are:
0 = Disconnected
65535 = Connected
Network Diagnostics Panel
DHCP Enabled LED - Only DHCP Enable can be read unless
using SymVue. The read back values are:
0 = DHCP Disabled
65535 = DHCP Enabled
Power Supply Diagnostics Panel
All voltages are in .001V increments offset by 32768. The
read back values of 0-65535 translate to -32.768V-32.767V.
Status LED - The read back values are:
0 = OK
65535 = Failed
Thermal Diagnostics Panel
Peak temperature date and time can only be read in
SymVue. All temperatures are in .01 degree C increments
offset by 32768. The read back values of 0-65535 translate
to -327.68V-327.67V.The Fan speed is 0-65535 Hz.
Status LED – Send -65535 to clear, The read back values are:
0 = OK
65535 = Failed
Control Diagnostics Panel
All read back values:
0 = Inactive/Off
65535 = Active/On
Parameter Notes
6 25
of
www.symetrix.co | T+1.425.778.7728

Getting Started and Control Commands
Other Parameters
Many other parameters such as compression ratios,
delay times, EQ settings and pans can also be controlled
externally. In fact, almost any DSP parameter in Composer
can be controlled. For other parameter types, as in the
above examples, sending a value of zero (0) will set the
parameter to its minimum value and sending a value of
(65535) will set it to its maximum value. Ratios, frequencies,
width/Q, and attack/release/hold times all use a logarithmic
scale. Pans and delay times use a linear scale. Quantities
expressed in dB such as gains, volumes, thresholds and
depths are linear in dB. When in doubt, experiment by
changing a value from the control application and reading it
back via RS-232 or Ethernet.
Parameters That Cannot Be Controlled
Externally
The following Composer features cannot be controlled
externally. In some cases, work arounds are suggested.
FUNCTION DESCRIPTION
1. Oscilloscope: Trigger and Auto-Range
controls
2. Parametric/British EQ: Flatten All and Octaves/Q
buttons
3. Graphic EQ: Flat button
4. Feedback Fighters: Response Preset buttons
5. Matrix: Mute All and Disconnect
All buttons (use individual
mute or disconnect buttons
instead)
6. Mixers: Link buttons (assign same
controller to all linked faders
instead)
7. SPL Computers: Calibrate button
8. Loudspeaker
Managers:
Flatten All
9. Send/Return: Meters (use meters inside
I/O blocks)
10. Delay: Default temperature button
11. Meter Bar: All meters
12. Fader Control Input: Log/linear buttons
13. String Output: All parameters
14. RS-232/485 Input: Controller number
Getting Started
Protocol
The Control Protocol is a text-based (ASCII string) protocol.
Commands are sent with simple character strings with terms
separated by spaces and completed with a carriage return
character <CR> (ASCII code decimal 13). The general form
for commands is:
<COMMAND> <PARAMETER1> <PARAMETER2> … <CR>
A white space character (space or tab) must be included
between the command and each parameter. Extra white
space characters can be sent for readability if desired. In
this document a single space will be used. If a command
is accepted, the unit will respond to each command with
an acknowledgement string whose syntax varies with each
command.
Control Commands
(CS) Controller Set
Use this command to move a controller position to a new
absolute value. The command must specify the controller
number and the new controller position. The syntax of the
command is:
CS <CONTROLLER NUMBER> <CONTROLLER
POSITION><CR>
Where <CONTROLLER NUMBER> is the decimal
controller number (1-10000) assigned in Composer, and
<CONTROLLER POSITION> is a 16-bit number in decimal
(0-65535).
If the command is accepted, the unit will respond with the
string:
ACK<CR>
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the specified controller
number does not exist.
7 25
of
www.symetrix.co | T+1.425.778.7728

Control Commands
(CSQ) Controller Set Quick
Use this command to move a controller position to a new
absolute value quicker than using the CS command. The
CS command may take up to 40ms before responding
with an ACK because the unit is verifying that the specified
<CONTROLLER NUMBER> exists in the site. The CSQ
response will be sent with 5-10ms for a single operation and
within 2ms each for single burst operations. The command
must specify the controller number and the new controller
position. The trade off is that the CSQ command will not
check to see if the specified <CONTROLLER NUMBER>
exists in the site. Note: It will always respond with an ACK
even if it does not. If your control system does not need to
check that the controller number was correctly set, the CSQ
command may be used without any downside.
The syntax of the command is:
CSQ <CONTROLLER NUMBER> <CONTROLLER POSITION><CR>
Where <CONTROLLER NUMBER> is the decimal
controller number (1-10000) assigned in Composer, and
<CONTROLLER POSITION> is a 16-bit number in decimal
(0-65535).
The device will respond with the string whether it recognizes
the controller number or not:
ACK<CR>
(CC) Change Controller
Use this command to move a controller to a new relative
value. This command will increment or decrement a
controller by a specified amount. The command must
specify the controller number, whether it should be
incremented or decremented, and the amount to change by.
The syntax of the command is:
CC <CONTROLLER NUMBER>
<DEC/INC> <AMOUNT><CR>
Where <CONTROLLER NUMBER> is the decimal controller
number (1-10000) assigned in Composer, <DEC/INC> is
0 to decrement and 1 to increment, and <AMOUNT> is
the amount to increment or decrement (a decimal number,
0-65535). If the amount to be decremented or incremented
causes the parameter to exceed its minimum or maximum
value, the value will be limited to its minimum or maximum
value. For example, if you increment a parameter by 10 and
its current value is 65530, the new value will be limited to
65535.
If the command is accepted, the unit will respond with the
string:
ACK<CR>
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the specified controller
number does not exist.
(GS) Get Controller
This command will return the controller position (value)
associated with a specific controller number. The command
must specify the controller number. The syntax of the
command is:
GS <CONTROLLER NUMBER><CR>
Where <CONTROLLER NUMBER> is the decimal controller
number (1-10000) assigned in Composer.
If the command is accepted, the unit will respond with the
string:
<CONTROLLER POSITION><CR>
Where controller position is a 16-bit number in decimal (0-
65535)
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the specified controller
number does not exist.
If the value being requested is a button that only has
two states, the returned values will be either 0 or 65535,
regardless of the actual value sent to the controller. For
example, assume controller number 1 controls a mute
button. If you send
CS 1 754 <CR>
and then
GS 1 <CR>
the response will be
0<CR>
not
754<CR>.
More generally, if the parameter you are controlling has
granularity coarser than the 16-bit values used, the returned
values will be quantized to the granularity of the parameter.
Controls where you might observe this effect are buttons as
mentioned above and input selectors.
If the same controller number is controlling multiple
parameters in Composer, only one acknowledgement value
is returned from the system.
8 25
of
www.symetrix.co | T+1.425.778.7728

Control Commands
(GS2) Get Controller with Controller
Number
This command will return the controller number with
controller position (value) associated with it together in the
same string. This command is provided at the request of
third-party control programmers, including AMX/Crestron
programmers, to make it easier to interpret and parse
returned controller positions. The command must specify
the controller number. The syntax of the command is:
GS2 <CONTROLLER NUMBER><CR>
Where <CONTROLLER NUMBER> is the decimal controller
number (1-10000) assigned in Composer.
If the command is accepted, the unit will respond with the
string:
<CONTROLLER NUMBER> <CONTROLLER POSITION><CR>
Where controller position is a 16-bit number in decimal
(65535).
For example, sending the command
GS2 368 <CR>
Will return the response in the format below when the
parameter value is 47114:
368 47114 <CR>
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the specified controller
number does not exist.
(GPR) Get Preset
This command will return the last preset that was loaded.
The syntax of the command is:
GPR<CR>
If the command is accepted, the unit will respond with the
string:
<PRESET NUMBER><CR>
The <PRESET NUMBER> return value will be 0-1000. A
return value of 0 indicates that no preset has been recalled.
The value for the preset number will always be 4 digits, with
leading zeros added as necessary (e.g. 7 would be returned
as 0007).
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
(GSB) Get Controller Block
This command will return the controller position (value) of
a specific range of consecutive controller numbers. The
command must specify the starting controller number and
the number of consecutive controllers to return. The syntax
of the command is:
GSB <CONTROLLER NUMBER> <BLOCK SIZE><CR>
Where <CONTROLLER NUMBER> is the decimal controller
number (1-10000) assigned in Composer and <BLOCK
SIZE> is the number of consecutive controllers. Note that
<BLOCK SIZE> can be at most 256.
If the command is accepted, the unit will respond with the
string:
<CONTROLLER POSITION1><CR>
<CONTROLLER POSITION2><CR>
<CONTROLLER POSITION3><CR>
…
<CONTROLLER POSITIONn><CR>
Where <CONTROLLER POSITIONn> is a 16-bit number
in decimal (0-65535), or -1 if a controller does not exist. The
values will always be five digits, with leading zeros added as
necessary (e.g. 7 would be returned as 00007<CR> and -1
would be returned as -0001<CR>.)
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the requested block size
is larger than 256. For more information and tips on reading
back controller numbers, see the GS command.
Example command sent:
GSB 9 3<CR>
Example Response:
32321<CR>
00256<CR>
00003<CR>
9 25
of
www.symetrix.co | T+1.425.778.7728

Control Commands
(GSB2) Get Controller Block with Controller
Number
This command will return the controller number with
controller position (value) associated with it for a specific
range of consecutive controller numbers. The command is
very similar to GSB described above, but the return string
may be easier to process in some systems. The command
must specify the starting controller number and the number
of consecutive controllers to return. The syntax of the
command is:
GSB2 <CONTROLLER NUMBER> <BLOCK SIZE><CR>
Where <CONTROLLER NUMBER> is the decimal controller
number (1-10000) assigned in Composer and <BLOCK
SIZE> is the number of consecutive controllers. Note that
<BLOCK SIZE> can be at most 256.
If the command is accepted, the unit will respond with the
string:
#<CONTROLLER NUMBER1>=
<CONTROLLER POSITION1><CR>
#<CONTROLLER NUMBER2>=
<CONTROLLER POSITION2><CR>
#<CONTROLLER NUMBER3>=
<CONTROLLER POSITION3><CR>
…
#<CONTROLLER NUMBERn>=
<CONTROLLER POSITIONn><CR>
Where <CONTROLLER NUMBERn> is the decimal
controller number (1-10000) assigned in Composer and
<CONTROLLER POSITIONn> is a 16-bit number in
decimal (0-65535), or -1 if a controller does not exist. The
values for the controller number and position will always be
five digits, with leading zeros added as necessary (e.g. 7
would be returned as 00007 and -1 would be returned as
-0001).
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the requested block size
is larger than 256. For more information and tips on reading
back controller numbers, see the GS command.
Example command sent:
GSB2 9 3<CR>
Example Response:
#00009=32321<CR>
#00010=00256<CR>
#00011=00003<CR>
(GSB3) Get Controller Block with Controller
Number
This command will echo the command and then return the
controller number with controller position (value) associated
with it for a specific range of consecutive controller numbers.
The command is very similar to GSB2 described above, but
the return string includes the original command followed by
the GSB2-style response. The syntax of the command is:
GSB3 <CONTROLLER NUMBER> <BLOCK SIZE><CR>
Where <CONTROLLER NUMBER> is the decimal controller
number (1-10000) assigned in Composer and <BLOCK
SIZE> is the number of consecutive controllers. Note that
<BLOCK SIZE> can be at most 256.
If the command is accepted, the unit will respond with the
string:
GSB3 <CONTROLLER NUMBER> <BLOCK SIZE> <CR>
#<CONTROLLER NUMBER1>=
<CONTROLLER POSITION1><CR>
#<CONTROLLER NUMBER2>=
<CONTROLLER POSITION2><CR>
…
#<CONTROLLER NUMBERn>=
<CONTROLLER POSITIONn><CR>
Where <CONTROLLER NUMBERn> is the decimal
controller number (1-10000) assigned in Composer and
<CONTROLLER POSITIONn> is a 16-bit number in
decimal (0-65535), or -1 if a controller does not exist.
If the command is interpreted but fails for any reason the unit
will respond with the string:
NAK<CR>
A typical reason for failure is that the requested block size is
larger than 256.
Example command sent:
GSB3 140 3<CR>
GSB3 00140 00003<CR>
00140=00000<CR>
00141=65535<CR>
00142=32768<CR>
10 25
of
www.symetrix.co | T+1.425.778.7728