Protocol Description; Instructions For The Terminal Application Usage; Legend For Control Commands; Renewed Protocol - Lightware MX-FR9 User Manual

   
7. Programmer's Reference
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 respond 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.2. Instructions for the Terminal Application Usage
Terminal Application
The LW2 protocol commands can be applied to the
UBEX endpoint devices using a terminal application.
You need to install one of them to your control device,
for example Putty or CLI. #terminal
Establishing Connection
Follow the steps for establishing connection to the
endpoints:
Step 1. Connect the device to a LAN over Ethernet
(see the details in the Connecting Steps
section).
Step 2. Open the terminal application (e.g. Putty).
Step 3. Add the IP address of the device (default:
192.168.0.100 and the port number (10001).
Step 4. Select the Raw connection type, and open the
connection.
Once the terminal window is opened, you can enter
the LW2 protocol commands, which are listed in the
following sections.
MX-FR Series Modular Matrix Frames – User's Manual
7.2.1. Legend for Control Commands
Format
<in>
<out>
<in/out>
<in2>
<out2>
<in2/out2> Input or output number in 2-digit ASCII format*
<loc>
<id>
<id2>
CrLf
<S/C/A>
* The command has the same arguments on the input ports and the output ports, as well.
7.2.2. Renewed Protocol
The MX-CPU2 processor board works with a similar but renewed protocol as the earlier generation matrix
frames with 'CPU1'. The affected commands that are heavily modified in the MX-CPU2 are marked.
7.2.3. Changing Protocols
The router is equipped with multiple router protocols. Different control interfaces can be set to use different
protocols. E.g. the Ethernet 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
Applied CPU2 firmware: v3.5.7b8 | LDC software: v2.5.17b2
Explanation
Input number in 1- or 2-digit ASCII format (01, 5, 07, 16, etc.)
Output number in 1- or 2-digit ASCII format
Input or output port number in 1- or 2-digit ASCII format *
Input number in 2-digit ASCII format (01, 02, 10, 12 etc.)
Output number in 2-digit ASCII format (01, 02, 10, 12 etc.)
Location number in 1-, 2- or 3-digit ASCII format
ID number in 1- or 2-digit ASCII format
ID number in 2-digit ASCII format
Carriage return, Line feed (0x0D, 0x0A)
Space character (0x20)
•
→ Each command issued by the controller
← Each response received from the router
Referring to the I/O card specific commands; S: single port, C: all ports of the card,
A: all (input or output) ports of the matrix
Control Protocols section) or by protocol commands.
100