Programmers' Reference; Overview; Protocol Rules; The Lw3 Tree Structure - Lightware VINX-120AP-HDMI-ENC-DNT User Manual

   
5.Programmers'Reference
5
P rogrammers' Reference
The device can be controlled through Lightware 3 (LW3) protocol commands
to ensure the compatibility with other Lightware products. The supported LW3
commands are described in this chapter.
ç Overview
ç ProtocolRules
ç SystemCommands
ç NetworkConfiguration
ç Encoder-relatedCommands
ç Decoder-relatedCommands
ç Audio-relatedCommands
ç SerialPortSettings
ç ArrangingtheExtenderstoGroups
ç VideoWallSettings
ç SettingupaVideoWall(Example)
ç CrosspointSwitchingExamples
ç EDIDManagement(Encoder)
ç LW3Commands-QuickSummary
VINX-1x0-HDMIExtenders–User'sManual

5.1. Overview

The Lightware Protocol #3 (LW3) is implemented in almost all new
Lightwaredevices(matrixswitchers,signalextendersanddistribution
amplifiers)since2012.TheprotocolisASCII-basedandallcommands
areterminatedwithacarriagereturn(Cr,'\r')andlinefeed(Lf,'\n')pair.
Itisorganizedasatreestructurethatprovidesoutstandingflexibility
and user-friendly handling with 'nodes', 'properties' and 'methods'. The
Advanced View of the built-in web page is the perfect tool for browsing
andlearninghowtheLW3protocolcanbeusedinpractice.

5.2. Protocol Rules

5.2.1. The LW3 Tree Structure

 /
 MEDIA
 VIDEO
 XP
SourcePortCount
SourcePortStatus
DestinationPortCount
DestinationPortStatus
DestinationPortAutoselect
[...]
 I1
 I2
 I3
I4
I5
 I6
 O1
 AUDIO
 UART
 IR
 GPIO
 ETHERNET
 EDID
 SYS
 MANAGEMENT
[...]
Appliedfirmwarepackage:v2.0.0b27 | LDCsoftware:v1.34.0b2

5.2.2. The LW3 Command Structure

Pathofthemethod/property
Command type
(GET/SET/CALL)
Command ç GET /SYS/MB/GPIO.DipSwitch
Response
æ pr /SYS/MB/GPIO.DipSwitch=0x8
Prefixoftheresponse Method/property
Pathofthemethod/property

5.2.3. Legend for the Control Commands

Command and Response – Example
ç GET•/SYS/MB/GPIO.DipSwitch
pr•/SYS/MB/GPIO.DipSwitch=<DIP_value>
æ
Format Description
<in> Input port number
<out> Output port number
<port> Input or output port number
<loc> Locationnumber
Sent command
ç
Received response
æ
• Space character
Further not listed <parameters>aredefinedateachcommands.

5.2.4. General Rules

▪ 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,thereceivedresponse
▪
cannot be processed by the CPU.
▪ The path of a node has to contain all parent nodes from the root
node.
41
Method/property
Parameters