
9. Programmer's Reference
UBEX series – Matrix Application Mode – User's Manual
103
9. Programmer's Reference
UBEX series – Matrix Application Mode – User's Manual
103
MA
TRIX APPLIC
A
TION MODE
Applied F-series endpoint firmware package: v1.4.1 | Applied R-series endpoint firmware package: v1.4.1 | Applied MMU firmware package: v1.2.1 | LDC software: v1.34.0b2
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.
9.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
of the Lightware Device Controller software is the perfect tool for browsing and learning
how the LW3 protocol can be used in practice.
9.2. Protocol Rules
9.2.1. LW3 Tree Structure and Command Structure (Examples)
9.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.
ç
CALL /MEDIA/VIDEO/XP:switch(S201:D802)
æ
mO /MEDIA/VIDEO/XP:switch
Command type
(GET/SET/CALL/MAN)
Prefix of the response
Path of the method/property
Path of the method/property
Method/property
Method/property
Parameters
Command
Response
/
MEDIA
EDID
VIDEOWALLS
XP
VIDEO
SourcePortCount
DestinationPortCount
[...]
AUDIO
DEVICEMAP
STREAMS
VIDEO
AUDIO
CONTROL
MANAGEMENT
SYS
EB
CECU
ENDPOINTS
UBEX0039A1
UBEX003C17
UBEX003E33
[...]
DISCOVERY
ç
ç
ç
The Tree Structure of the UBEX Matrix
ç
ç
ç
ç
ç
Video Stream Settings - Source (Input) Side
ç
Video Stream Settings - Destination (Output) Side
ç
ç
ç
ç
ç
ç
ç
ç
Ethernet Port Configuration - Endpoint
ç
Serial Port Configuration - MMU
ç
Serial Port Configuration - Endpoint Devices
ç
Infrared Port Configuration - Endpoint Devices
ç
Message Sending via Communication Ports
ç
ç