Table of Contents
Advertisement
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.
www.symetrix.co
|
T
+1.425.778.7728
Introduction and General Notes
Symetrix (Terminal Block Female)
Terminal Block
Pin Signal
Pin 1
Pin 3
1
Ground
2
RX
3
TX
Pin 2
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:
3
of
25
Control System (DB9 Male)
DB9 Male
Pin Signal
Pin 1
Pin 5
1
2
TX
3
RX
4
5
Ground
6
7
8
9
Pin 6
Pin 9
Advertisement
Table of Contents
Need help?
Do you have a question about the Composer v7.0 and is the answer not in the manual?
Questions and answers