8. LW3 Programmers' Reference
MMX8x4-HT series – User's Manual
96
Applied firmware package: v1.2.2b5 | LDC software: v2.2.1
8.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.
8.2.
Protocol Rules
8.2.1.
LW3 Tree Structure and Command Structure (examples)
8.2.2.
General Rules
▪
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.
▪
Use the
TCP
port no. 6107
when using LW3 protocol over Ethernet.
▪
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.
Ý
CALL /MEDIA/VIDEO/XP:switch(I1:O1;I2:O2)
Ü
mO /MEDIA/VIDEO/XP:switch
Command type
(GET/SET/CALL/MAN)
Prefix of the response
Path of the method/property
Path of the method/property
Method/property
Method/property
Parameters
Command
Response
/
MEDIA
VIDEO
XP
SourcePortCount
SourcePortStatus
DestinationPortCount
DestinationPortStatus
DestinationPortAutoselect
[...]
I1
I2
I3
I4
I5
I6
O1
AUDIO
UART
IR
GPIO
ETHERNET
EDID
SYS
MANAGEMENT
[...]
8.2.3.
Command Types
GET command
The
GET
command can be used to get the child nodes, properties and methods of a specific node. It can also
be used to get the value of a property. Use the dot character (.) when addressing a property:
Ý
GET /.SerialNumber
Ü
pr /.SerialNumber=87654321
GETALL command
The
GETALL
command can be used to get all child nodes, properties and methods of a node with one
command.
Ý
GETALL /MEDIA/UART
Ü
ns /MEDIA/UART/P1
Ü
ns /MEDIA/UART/P2
Ü
pr /MEDIA/UART.PortCount=2
Ü
pr /MEDIA/UART.PortUi=P1:12209;P2:12224
Ü
pr /MEDIA/UART.P1=Local RS-232
Ü
pr /MEDIA/UART.P2=TPS out RS-232
SET command
The
SET
command can be used to modify the value of a property. Use the dot character (.) when addressing
the property:
Ý
SET /MEDIA/VIDEO/I1.ColorSpaceMode=0
Ü
pw /MEDIA/VIDEO/I1.ColorSpaceMode=0
CALL command
A method can be invoked by the
CALL
command. Use the colon character (:) when addressing the method:
Ý
CALL /MEDIA/VIDEO/XP:switch(I1:O1)
Ü
mO /MEDIA/VIDEO/XP:switch
MAN command
The manual is a human readable text that describes the syntax and provides a hint for how to use the
primitives. For every node, property and method in the tree there is a manual, type the MAN command to get
the manual:
Ý
MAN /MEDIA/VIDEO/O1.Pwr5vMode
Ü
pm /MEDIA/VIDEO/O1.Pwr5vMode ["0" | "1" | "2"] 0 - Auto, 1 - Always On, 2 - Always Off
