Table of Contents
Advertisement
7. LW3 Programmers' Reference
7.1. Overview
The Lightware Protocol #3 (LW3) is implemented in almost all new Lightware devices (matrix switchers,
signal extenders and distribution amplifiers) since 2012. The protocol is ASCII-based and all commands
are terminated with a carriage return (Cr, '\r') and line feed (Lf, '\n') pair. It is organized as a tree structure
that provides outstanding flexibility and user-friendly handling with 'nodes', 'properties' and 'methods'. The
Advanced View of the Lightware Device Controller software is the perfect tool for browsing and learning how
the LW3 protocol can be used in practice.
7.2. Instructions for the Terminal Application Usage
Terminal Application
The LW3 protocol commands can be applied to the
receiver 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
receiver:
Step 1. Connect the receiver to a LAN over Ethernet.
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 (6107).
Step 4. Select the Raw connection type, and open the
connection.
Once the terminal window is opened, you can enter
the LW3 protocol commands which are listed in the
following sections.
LW3 protocol command communication in a terminal window
RAP-B511 series – User's Manual
7.3. Protocol Rules
7.3.1. LW3 Tree Structure and Command Structure (examples)
/
7.3.2. General Rules
Applied firmware package: v1.1.0b3b3 | LDC software: v2.5.1b5
MEDIA
MANAGEMENT
LOG
OS
STATUS
UID
Command type
NETWORK
(GET/SET/CALL/MAN)
UI
VOLUMECONTROL
BUTTONS
LEDS
Command
GROUP
ROTARYLEDS
Response
LABEL
INDEXFILE
EVENTS
Prefix of the response
SYS
[...]
▪
All names and parameters are case-sensitive.
The nodes are separated by a slash ('/') character.
▪
▪
The node name can contain the elements of the English alphabet and numbers.
▪
The command lines have to be closed by Carriage return and Line Feed (CrLf).
Use the TCP port no. 6107 when using LW3 protocol over Ethernet.
▪
▪
The length of a line (command/response, command type / prefix, path, method/property and
parameters together) can be max. 800 byte.
When a command is issued by the device, the received response cannot be processed by the CPU.
▪
The node paths describe the exact location of the node, listing each parent node up to the root.
▪
66
Path of the method/property
Method/property
Parameters
ç CALL /MEDIA/UART/P1:sendMessage(...)
æ mO /MEDIA/UART/P1:sendMessage
Method/property
Path of the method/property
Advertisement
Table of Contents
Troubleshooting
