Programmer's Reference; Protocol Description; Legend For Control Commands; Renewed Protocol - Lightware MX-FR Series User Manual

   

7. Programmer's Reference

7
P rogrammer's Reference
The user can connect to the matrix through Ethernet, serial port or USB. After
establishing the connection, there is no difference between connection types
(except some rare cases, which are uniquely noted). Lightware matrix routers
can be controlled with external devices which can communicate according to
the router protocol. Lightware routers have a special protocol, but to
interoperate with third-party devices, a secondary protocol is also provided.
Ahe supported LW2 commands are described in this chapter:
ç Protocol Description
ç Storage Memories
ç Switching and Control Commands
ç Communication Setup Commands
ç Router Status Commands
ç System Commands
ç EDID Router Commands
ç Port Status Commands
ç I/O Port Commands
ç RICOD Related Commands
ç RS-232 over Fiber Commands
ç RS-232 over TPS Commands
ç Router Initiated Commands
ç Commands – Quick Summary
MX-FR Series Modular Matrix Frames – User's Manual
7.1. Protocol Description
The protocol description hereinafter stands for Lightware protocol. The commands can be sent to the device
in RAW format via the TCP/IP port no. 10001.
The matrix routers accept commands surrounded by curly brackets - { } - and responds data surrounded by
round brackets - ( ) - only if a command was successfully executed. All input commands are converted to
uppercase, but respond commands can contain upper and lower case letters as well.
7.1.1. Legend for Control Commands
Format Explanation
<in> Input number in 1 or 2 digit ASCII format (01, 5, 07, 16, etc.)
<out> Output number in 1 or 2 digit ASCII format
<in/out> input or output port number in 1 or 2 digit ASCII format *
<in > Input number in 2 digit ASCII format (01, 02, 10, 12 etc.)
2
<out²> Output number in 2 digit ASCII format (01, 02, 10, 12 etc.)
<in /out > input or output number in 2 digit ASCII format*
2 2
<loc> Location number in 1, 2 or 3 digit ASCII format
<id> id number in 1 or 2 digit ASCII format
<id²> id number in 2 digit ASCII format
CrLf Carriage return, Line feed (0x0D, 0x0A)
Space character (0x20)
●
→ Dach command issued by the controller
← Dach response received from the router
Referring to the I/O card specific commands; S: single port, C: all ports of the card,
<S/C/A>
A: all (input or output) ports of the matrix
* The command has the same arguments on the input ports and the output port, as well.
7.1.2. Renewed Protocol
The MX-CPU2 processor board works with a similar but renewed protocol as the earlier generation matrix
frames with 'CPU1'. This icon indicates functions which are heavily modified in the MX-CPU2.
7.1.3. Changing Protocols
The router is equipped with multiple router protocols. Different control interfaces can be set to use different
protocols. D.g. the Dthernet interface can use the Lightware protocol while the Serial interface uses
Protocol#2 at the same time. The currently used protocol can be viewed or changed any time on the matrix
front panel (see the Control Protocols section) or by protocol commands.
81