Lw3 Programmers' Reference; Overview; Protocol Rules; Lw3 Tree Structure And Command Structure (Examples) - Lightware RAP-B511-EU-K 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

Ý

Protocol Rules

Ý
System Commands
Ý
Time Settings
Ý
Button Configuration
Ý
Button LED Configuration
Ý
Button Group Configuration
Ý
Volume Control Configuration
Ý
Network Configuration
Ý
RS-232 Port Configuration
Ý
RS-232 Recognizer
Ý
Infrared Port Configuration
Ý
GPIO Port Configuration
Ý
Sending Message via the Communication Ports
Ý
LW3 Quick Summary
Ý
RAP-B511 series – User's Manual
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
Advanced View 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
 MANAGEMENT
 MANAGEMENT
 LOG
 OS
 STATUS
 UID
 NETWORK
 UI
 VOLUMECONTROL
 BUTTONS
 LEDS
 GROUP
 ROTARYLEDS
 LABEL
 INDEXFILE
 EVENTS
 SYS
[...]
7.2.2. 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 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/UART/P1:sendMessage(...)
Response
Ü mO /MEDIA/UART/P1:sendMessage
Prefix of the response Method/property
Path of the method/property
44
Parameters