Lw3 Programmer's Reference; Overview; Elements Of The Tree Structure - Lightware HDMI-TPS-TX210 User Manual


  

7. LW3 Programmer's Reference

7
L W3 Programmer' s 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

Î
The Tree Structure of the Transmitter
Î
LW3 Commands
Î
Formal Definitions
Î
System Commands
Î
Video Port Settings
Î
Audio Port Settings
Î
Network Configuration
Î
RS-232 Port Configuration
Î
Infrared Port Configuration
Î
Sending Message via the Communication Ports
Î
GPIO Port Configuration
Î
EDID Management
Î
LW3 Commands - Quick Summary
Î
HDMI-TPS-TX200 series – User's Manual
7.1. Overview
Lightware 3 (LW3) protocol is used by the 25G hybrid matrix, the MODEX family and the new series of
Lightware TPS and OPT products, including the HDMI-TPS-TX200 series transmitters. The protocol (LW3)
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 for implementing a human readable,
but programmatically still ease to parse, which is suitable for different products with a different feature list.
In order to implement a flexible, easy-to-use protocol that is straightforward to adapt to new devices and
provides outstanding scalability and sustainability, we decided to organize all settings, parameters and
properties of the device to a tree structure with 'nodes', 'properties' and 'methods'.
7.1.1. Elements of the Tree Structure
ATTENTION! All names and values are case-sensitive. The space character is replaced by the '●' character
in the elements and commands descriptions.
7.1.1.1. Node
The basic building block of the tree structure is the 'node'.
▪
▪ The node can have multiple child nodes, but only one parent.
▪ The tree has only one root the 'root node'.
The leaves of the tree are also nodes, which do not have child nodes.
▪
The nodes are separated by a slash ('/') character.
▪
▪ All the slashes are 'right slashes', no backslash is used.
▪ The identifier of the root node is a slash ('/')
The node name can contain the elements of the English alphabet and numbers.
▪
▪ Recommended convention for case sensitivity:
– Fix nodes (that cannot be altered) are capitalized.
– User created nodes can contain both lowercase and capital letters, no restrictions.
▪ The path of a node has to contain all parent nodes from the root node.
Format: (the root node): nX●/
Path: nX●/[nodeName]/[nodeName]/[nodeName]
Legend:
n:
'X' can be:
'-':
'm':
'E':
's':
'v':
'r':
node
default for a node.
this is a manual for the node.
this is an error message for the node.
this is a symlink node.
this node has virtual children.
this is a remote node.
49