Lw3 Programmers' Reference; Overview; Elements Of The Tree Structure; Node - Lightware MMX8x8-HDMI-4K-A User Manual


  

7. LW3 Programmers' Reference

7
L W3 Programmers' 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

Ý

Elements of the Tree Structure

Ý
Controls and Prefixes
Ý
Tree Structure Examples
Ý
LW3 Commands
Ý
Formal Definitions
Ý
System Commands
Ý
Switching and Crosspoint Settings
Ý
Video Port Settings
Ý
EDID Management
Ý
AUX Analog Audio I/O Port Settings
Ý
Advanced Audio Settings
Ý
Serial Port Settings
Ý
IR Port Settings
Ý
Relay Port Settings
Ý
GPIO Port Settings
Ý
Network Configuration
Ý
Sending Message via the Communication Ports
Ý
System Monitoring Commands
Ý
MMX8x4-HT series – User's Manual
7.1. Overview
Lightware 3 (LW3) protocol is used by more and more Lightware products ; 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 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.2. 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.2.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:

node

'X' can be:
'-': default for a node.
'm': the manual of the node.
'E': error message for the node.
's': this is a symlink node.
'v': this node has virtual children.
'r': this is a remote node.
INFO: All parent nodes must be listed in the path of a node.
61