Overview; Instructions For The Terminal Application Usage; Protocol Rules; Lw3Treestructureandcommandstructure(Examples) - Lightware HDMI-TPS-TX226 User Manual

   
7.LW3Programmer'sReference
7.1. Overview
TheLightware Protocol #3(LW3) isimplementedinalmostallnewLightwaredevices(matrixswitchers,
signal extenders and distribution amplifiers) since 2012.The protocol is ASCII-based and all commands
areterminatedwithacarriagereturn(Cr,'\r')andlinefeed(Lf,'\n')pair.Itisorganizedasatreestructure
thatprovidesoutstandingflexibilityanduser-friendlyhandlingwith'nodes','properties'and'methods'.The
Advanced ViewoftheLightwareDeviceControllersoftwareistheperfecttoolforbrowsingandlearninghow
theLW3protocolcanbeusedinpractice.
7.2. Instructions for the Terminal Application Usage
Terminal Application
TheLW3 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. ConnectthereceivertoaLANoverEthernet.
Step 2. Opentheterminalapplication(e.g.Putty).
Step 3. Add the IP address of the device (default:
192.168.0.100)andtheport number (6107).
Step 4. SelecttheRaw connection type, and open the
connection.
Once the terminal window is opened, you can enter
theLW3protocolcommandswhicharelistedinthe
followingsections.
LW3 protocol command communication in a terminal window
HDMI-TPS-TX200series–User'sManual
7.3. Protocol Rules
7.3.1. LW3 Tree Structure and Command Structure (examples)
 /





7.3.2. General Rules
▪
▪
▪
▪
▪
▪
▪
▪
Appliedfirmwarepackage:v1.3.2b3 | LDCsoftware:v2.5.7b2
 MEDIA
VIDEO
XP
   SourcePortCount
   SourcePortStatus
   DestinationPortCount
Command type
   DestinationPortStatus
   [...] (GET/SET/CALL/MAN)
I1
 I2
O1
Command
 O2
AUDIO Response
UART
IR
ETHERNET
Prefixoftheresponse
 CEC
 EDID
EVENTS
PRESETS
SYS
 MANAGEMENT
REMOTE
[...]
All names and parameters are case-sensitive.
Thenodesareseparatedbyaslash('/')character.
ThenodenamecancontaintheelementsoftheEnglishalphabetandnumbers.
The length of a line (command/response, command type / prefix, path, method/property and
parameterstogether)canbemax. 800 byte.
ThecommandlineshavetobeclosedbyCarriagereturnandLineFeed(CrLf)
UsetheTCP port no. 6107whenusingLW3protocoloverEthernet.
Whenacommandisissuedbythedevice,thereceivedresponsecannotbeprocessedbytheCPU.
Thenodepathsdescribetheexactlocationofthenode,listingeachparentnodeuptotheroot.
80
Pathofthemethod/property
Method/property
Parameters
ç CALL /MEDIA/VIDEO/XP:switch(I1:O2)
æ mO /MEDIA/VIDEO/XP:switch
Method/property
Pathofthemethod/property