Lightware UCX-2x1-HC30, User Manual

Page: 105 / 167

7. LW3 Programmers’ Reference UCX series – User's Manual 105
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
8.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.
8.2. Instructions for the Terminal Application Usage
Terminal Application
The LW3 protocol commands can be applied to the
switcher using a terminal application. You need to
install one of them to your control device, for example
Putty
or
CLI
. #terminal
Establishing Connection
Follow the steps for establishing connection to the
switcher:
Step 1.
Connect the swiitcher to a LAN over Ethernet.
Step 2.
Open the terminal application (e.g. Putty).
Step 3.
Add the
IP address
of the device (default:
DHCP) and the
port number (6107)
.
Step 4.
Select the
Raw
connection type, and open the
connection.
Once the terminal window is opened, you can enter
the LW3 protocol commands which are listed in the
following sections.
LW3 protocol command communication in a terminal window
8.3. Instructions for the Websocket (WS) or Secured Websocket (WSS) Usage
DIFFERENCE: Websocket (WS) or Secured Websocket (WSS) service is available only from FW package
v1.2.0.
UCX series switcher provides WS/WSS services on its 80 (for WS) and 443 (for WSS) ports to control the device
with LW3 protocol commands. For more details about the websocket see WebSocket Service (WS, WSS) section.
The LW3 node tree is available after opening a session with the device on the following path:
▪ ws:// <ip> /lw3
▪ wss:// <ip> /lw3
WebSocket Client Application
Establishing Connection
Follow the steps for establishing connection to
the switcher:
Step 1.
Connect the receiver to a LAN over
Ethernet.
Step 2.
Open the websocket client (e.g. Simple
websocket Client).
Step 3.
Add the
IP address
of the device (default:
DHCP): ws:// <ip> /lw3 or wss:// <ip> /lw3
Step 4.
Press the open/connect button.
Step 5.
Once connected, enter a message
and press the Send button. The LW3
protocol commands which are listed in
the following sections
Step 6.
Press the Close/Disconnect button to
end the session.
   