External Control Protocol; General Protocol Behavior - Shure DDS 5900 User Manual

11 External Control Protocol

The DDS 5900 Digital Discussion System features an
Ethernet connection for the purpose of providing an
interface to control and monitor the system. By setting up
a simple (raw) TCP/IP socket connection to the CU 5905
Central Unit, control options are available.
This section describes the TCP/IP raw socket protocol for
communicating with the DDS 5900 Discussion System.
This protocol provides a short set of commands, enabling
a third part control application to monitor and/or control
system status of a DDS 5900 Discussion System.
Some examples of functionally available using the protocol:
• Setting a microphone in speak or in request
• Retrieving a list of seats available in the system.

11.1 General Protocol Behavior

11.1.1 TCP/IP socket connection
A TCP/IP socket connection to the CU 5905 must be
established for the External Control protocol to become
available. Configuration of the CU 5905 connection to the
Ethernet must be defined from the CU interactive front
plate control/Browser interface and an IP address for the
CU 5905 must be assigned in the network.
Choose either a static IP address or an IP address
assigned through DHCP. It is convenient to ensure, that
the CU 5905 ends up with the same IP address at each
start up.
Knowing the IP address, the only additional information
required for setting up a TCP/IP connection is the Port
Number:
11.1.2 Command Structure (from External Control to CU 5905)
To control the CU an External Control sends commands to
CU 5905 included in command lines. Commands lines are
build up in a very simple manner:
<command><SP><data><CR>
<command><SP><data><LF>
<SP> Space - 0x20 = 32
<CR> Carriage return - 0x0D = 13
<LF> Line Feed - 0x0A = 10
Command lines are terminated by a Carriage Return
<CR> or Line Feed <LF> or both. In order to be able
to communicate with Windows systems, Linux systems
or other systems, the CU understands both types of
command line terminations.
This interface supports applications developed by
customers, so the protocol is deliberately kept simple. The
External Control protocol offers a means for supplementing
the control functionality available through the DDS 5900
Browser interface and the CU 5905 interactive display,
however some commands and settings available in the
browser interface and on the CU 5905 interactive display
are not available using the 'External Control Protocol'
Customer applications can include but are not limited to
AMX or Crestron room control systems, PC or micro
® ®
controller based applications, e.g., for button mimics and
camera control applications.
Port Number = 3142
Example: Test connection to CU via Putty
CU 5905 is assigned IP address 192.168.1.100, the
external application must connect the TCP/IP socket
to the address 192.168.1.100:3142.
Knowing the IP address of the CU 5905 a connection can
be set up using a simple terminal program like Putty.
1. Download at www.putty.org
2. Start Putty.
3. Insert IP address and Port Number.
4. Select 'Raw' for the Connection Type.
5. Press 'Open' to establish connection to the CU. Control
is now possible.
6. Type 'help' to see a list of commands available.
Notice also, there is a space between the command and
data. If a command does not carry any data, space is
possible but not required.
The CU is not sensitive to upper/lower case.
Example:
mic_on 212<CR>
Turn on microphone at seat 212. Command = mic_on,
data = 212. The 'mic_on' command carries a seat number
as data.
: If the
®