Overview; Instructions For The Terminal Application Usage; Protocol Rules; Lw3 Tree Structure And Command Structure (Examples) - Lightware UBEX-MMU-X200 User Manual

 
     
9. Programmer's Reference 9. Programmer's Reference
9.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
Terminal Window of the Lightware Device Controller software is the perfect tool for browsing and learning
how the LW3 protocol can be used in practice.
9.2. Instructions for the Terminal Application Usage
Terminal Application
The LW3 protocol commands can be applied to the
UBEX matrix 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
device:
Step 1. Connect the MMU to a LAN over Ethernet (see
the details in the Matrix Management Unit
(MMU) section).
Step 2. Open the terminal application (e.g. Putty).
Step 3. Add the IP address of the MMU (the default is
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
Applied F-series endpoint firmware package: v1.5.4 | Applied R-series endpoint firmware package: v1.5.4 | Applied MMU firmware package: v1.3.3 | LDC software: v2.4.2b4
series – Matrix Application Mode – User's Manual series – Matrix Application Mode – User's Manual
9.3. Protocol Rules
9.3.1. LW3 Tree Structure and Command Structure (Examples)
 /
 MEDIA
 DEVICEMAP
 XP
 VIDEO
 AUDIO
 STREAMS
 VIDEO
 AUDIO
 CONTROL
 EDID
 VIDEOWALLS
 MANAGEMENT
 SYS
 EB
 CECU
 ENDPOINTS
 UBEX0039A1
 UBEX003C17
 UBEX003E33
[...]
 DISCOVERY
9.3.2. General Rules
▪ All names and parameters are case-sensitive.
▪ The nodes are separated by a slash ('/') character.
▪ The node names are comprised of the elements of the English alphabet and numbers.
▪ Use the TCP port no. 6107 when using LW3 protocol over Ethernet.
▪ Node paths describe the exact location of the node, listing each parent node up to the root.
▪ The length of a line (command/response, command type / prefix, path, method/property and
parameters together) can be max. 800 byte.
The command lines have to be closed by Carriage return and Line Feed (CrLf)
▪
SourcePortCount
DestinationPortCount
Command type
[...]
(GET/SET/CALL/MAN)
Command ç CALL /MEDIA/VIDEO/XP:switch(S201:D802)
Response
æ mO /MEDIA/VIDEO/XP:switch
Prefix of the response
131 131
Path of the method/property
Method/property
Parameters
Method/property
Path of the method/property