7. LW3 Programmers’ Reference
UCX series – User's Manual
106
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
8.4.
Protocol Rules
8.4.1.
LW3 Tree Structure and Command Structure (examples)
8.4.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.
▪
The 80 port can be used for
WS (instead of HTTP)
▪
The 443 port can be used for
WSS (instead of HTTPS)
▪
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.
▪
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)
▪
It can manage 18 connected clients simultaneously for WS (80), WSS (443), and LW3 (6107) ports
in total.
ç
CALL /V1/MEDIA/VIDEO/XP:switch(I1:O2)
æ
mO /V1/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
/
V1
MEDIA
VIDEO
XP
I1
I2
I3
I4
O1
O2
AUTOSELECT
AUDIO
USB
ETHERNET
EDID
MANAGEMENT
SYS
[...]
8.4.3.
Legend for the Control Commands
Command and Response – Example
ç
GET·/V1/MEDIA/VIDEO/I2.SignalPresent
æ
pr·/V1/MEDIA/VIDEO/I2.SignalPresent=
<signal_present>
Format
Description
<in>
Input port number
<out>
Output port number
<port>
Input or output port number
<loc>
Location number
<parameter>
Variable defined and described in the command
<expression>
Batched parameters: the underline means that more
expressions or parameters can be placed by using a
semicolon, e.g.
I2;I4;I5
or
F27:E1;F47:E2
ç
Sent command
æ
Received response
·
Space character
Further not listed
<parameters>
are defined at each commands.
