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


  
7.LW3Programmers'Reference
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. Connect the receiver to a LAN over Ethernet
(see the details in the Connecting Steps
section).
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
HDMI-TPS-RX110AY series – User's Manual
7.3. Protocol Rules
7.3.1. LW3 Tree Structure and Command Structure (examples)
 /

7.3.2. General Rules
▪
▪
▪
▪
▪
▪
Appliedfirmwarepackage:v1.4.0 | LDCsoftware:v2.4.0b3
 MEDIA
VIDEO
 XP
SourcePortCount
SourcePortStatus
DestinationPortCount
DestinationPortStatus Command type
   [...]
(GET/SET/CALL/MAN)
 I1
 O1
 AUDIO
 UART Command
 IR
Response
RELAY
 ETHERNET
 CEC
Prefixoftheresponse
 EDID
EVENTS
 PRESETS
 SYS
 MANAGEMENT
 REMOTE
[...]
All names and parameters are case-sensitive.
Thenodesareseparatedbyaslash('/')character.
The node name can contain the elements of the English alphabet and numbers.
Use the TCP port no. 6107whenusingLW3protocoloverEthernet.
Whenacommandisissuedbythedevice,thereceivedresponsecannotbeprocessedbytheCPU.
The node paths describe the exact location of the node, listing each parent node up to the root.
66
Pathofthemethod/property
Method/property
Parameters
Î CALL /MEDIA/VIDEO/XP:mute(O1)
Í mO /MEDIA/VIDEO/XP:switch
Method/property
Pathofthemethod/property