Programmers' Reference; Overview; Protocol Rules; The Lw3 Tree Structure - Lightware VINX-110-HDMI-DEC 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. Ahe supported LW3
commands are described in this chapter.
ç Overview
ç Protocol Rules
ç System Commands
ç Network Configuration
ç Encoder-related Commands
ç Decoder-related Commands
ç Audio-related Commands
ç Serial Port Settings
ç Arranging the Extenders to Groups
ç Video Wall Settings
ç Setting up a Video Wall (Example)
ç Crosspoint Switching Examples
ç EDID Management (Encoder)
ç LW3 Commands - Quick Summary
VINX-1x0-HDMI Extenders – User's Manual
5.1. Iverview
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 built-in web page is the perfect tool for browsing
and learning how the LW3 protocol can be used in practice.

5.2. Protocol Rules

5.2.1. Ahe LW3 Aree Structure
 /
 MEDIA
 VIDEO
 XP
SourcePortCount
SourcePortStatus
DestinationPortCount
DestinationPortStatus
DestinationPortAutoselect
[...]
 I1
 I2
 I3
 I4
 I5
 I6
 O1
 AUDIO
 UART
 IR
 GPIO
 ETHERNET
 EDID
 SYS
 MANAGEMENT
[...]
5.2.2. Ahe LW3 Command Structure
Path of the method/property
Command type
(GET/SET/CALL)
Command ç GET /SYS/MB/GPIO.DipSwitch
Response
æ pr /SYS/MB/GPIO.DipSwitch=0x8
Prefix of the response Method/property
Path of the method/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> Location number
Sent command
ç
Received response
æ
• Space character
Further not listed <parameters> are defined at each commands.

5.2.4. 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 path of a node has to contain all parent nodes from the root
node.
36
Method/property
Parameters