Programmers' Reference; Overview; Protocol Rules; Lw3 Tree Structure And Command Structure (Examples) - Lightware UBEX-PRO20-HDMI-F110 User Manual

 
     

7. Programmers' Reference

7. Programmers' Reference
7
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
ç Protocol Rules
ç System Commands
ç Video Port Settings - Transmitter Mode
ç Video Port Settings - Receiver Mode
ç Video Port Settings - Transceiver Mode
ç Audio Port Settings
ç Analog Audio Port Settings
ç System Monitoring Commands
ç SFP+ Module Information
ç EDID Management
ç Network Configuration
ç RS-232 Port Configuration
ç Infrared Port Configuration
ç Message Sending via Communication Ports
ç LW3 Protocol Commands - Quick Summary
UBEX series – Extender Application Mode – User's Manual UBEX series – Extender Application Mode – User's Manual
Applied F-series endpoint firmware package: v1.4.1 | Applied R-series endpoint firmware package: v1.4.1 | LDC software: v1.34.0b2
7.1. Overview
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
Terminal Window of the Lightware Device Controller software is the perfect tool for browsing and learning
how the LW3 protocol can be used in practice.
7.2. Protocol Rules
7.2.1. LW3 Tree Structure and Command Structure (Examples)
 /
 MEDIA
 VIDEO
 XP
SourcePortCount
SourcePortStatus
DestinationPortCount
DestinationPortStatus
PortGroupList
[...]
 I1
 O1
 S1
 I2
 O2
 S2
 D1
 D2
 O3
 O4
 AUDIO
 ETHERNET
 EDID
 SYS
 MANAGEMENT
 REMOTE
7.2.2. General Rules
▪ All names and parameters are case-sensitive.
▪ The nodes are separated by a slash ('/') character.
▪ The node names are comprised of the elements of the English alphabet and numbers.
▪ Use the TCP port no. 6107 when using LW3 protocol over Ethernet.
▪ Node paths describe the exact location of the node, listing each parent node up to the root.
Path of the method/property
Command type Method/property
(GET/SET/CALL/MAN)
Command ç CALL /MEDIA/VIDEO/XP:switch(S1:D2)
Response
æ mO /MEDIA/VIDEO/XP:switch
Prefix of the response Method/property
Path of the method/property
73 73
Parameters