1.Introduction
1.1.Description
1.2.Box Contents
1.3.Typical Application
1.4.Features of the Device
2.Product Overview
2.1.UCX-4x3-TPN-TX20
2.2.UCX-2x1-TPN-TX20
2.3.DCX-3x1-TPN-TX10
3.Front Panel Control
3.1.Button Functionality
3.1.1.Video Source Selection - UCX-4x3-TPN-TX20
3.1.2.Video Source Selection - UCX-2x1-TPN-TX20
3.1.3.Video Source Selection - DCX-3x1-TPN-TX10
3.1.4.Enabling DHCP IP Address
3.1.5.Reset to Factory Default Settings
3.1.6.Control Lock
3.2.Status LEDs
3.2.1.Front Panel LEDs
3.2.2.Rear Panel LEDs
3.2.3.Ethernet Status LEDs
3.2.4.TPN Connector LEDs
4.Installation
4.1.Mounting Options
4.1.1.1U High Rack Shelf
4.1.2.Mounting Plate F100
4.1.3.C-Lock
4.1.4.H-Lock
4.2.Electrical Connections
4.2.1.HDMI Input and Output Ports
4.2.2.USB Connectors
4.2.3.Analog Stereo Audio
4.2.4.TPN (SDVoE) Connector
4.2.5.Configurable Ethernet Port
4.2.6.RS-232 Connector
4.2.7.GPIO - General Purpose Input/Output Ports
4.3.Powering Options
4.4.Power Delivery over Type-C
4.4.1.Power Data Objects (USB-C)
4.5.USB-C Cable Recommendation
4.6.Ethernet Switch - Detailed Requirements
4.7.Connecting Steps
5.Device Concept
5.1.Universal Switcher Concept
5.2.USB Interface
5.2.1.USB-C Interface
5.2.2.USB Data - USB 2.0 Interface
5.2.3.USB Service Ports - USB 2.0 Interface
5.3.Video Interface
5.3.1.Welcome Screen
5.3.2.Video Port Diagrams
5.3.3.DisplayPort Alternate Mode
5.4.The Autoselect Feature
5.5.Audio Interface
5.5.1.Analog Audio Interface
5.6.Ethernet Interface
5.7.Lightware Advanced Room Automation (LARA)
5.7.1.Opening the LARA interface
5.7.2.Running LARA
5.7.3.Downloading/Uploading a Configuration
5.7.4.Status Board
5.7.5.Touch Panel Support
5.8.Basic Network Security
5.8.1.Disable Ethernet Ports
5.8.2.HTTP/HTTPS
5.8.3.Encryption (HTTPS, WSS)
5.9.802.1x Authentication
5.10.Advanced Ethernet Security
5.11.Lightware Crypto Core
5.12.WebSocket Service (WS, WSS)
5.13.Bulk Device Management
5.13.1.Network Settings
5.13.2.Device Configuration
5.14.Serial Interface
5.14.1.Serial Port Diagram
5.15.GPIO Interface
5.16.OCS Interface
5.17.Further Built-in Features
5.17.1.Device Cloning – Configuration Backup and Restore
5.17.2.SNMP Monitoring
5.17.3.Remote System Logging
6.Software Control Options
6.1.Software Control Modes
6.2.Using the Built-in Web
6.3.Install and Update the LDC
6.4.Running the LDC
6.5.Establishing the Connection
6.6.Bulk Device Management
6.6.1.Network Settings
6.6.2.Device Configuration
6.7.Video & Audio Crosspoint
6.7.1.Port Tiles
6.8.Port Properties Window
6.8.1.Welcome Screen
6.8.2.USB-C Inputs
6.8.3.HDMI Video Input
6.8.4.HDMI Video Output
6.8.5.Embedded Audio Input
6.8.6.Analog Audio Output
6.8.7.Frame Detector
6.9.CEC Tool
6.10.USB Crosspoint
6.10.1.USB-C Port Properties
6.10.2.USB-B Port Properties
6.10.3.USB Hub Properties
6.11.EDID Menu
6.11.1.EDID Operations
6.11.2.EDID Summary Window
6.11.3.Editing an EDID
6.11.4.Creating an EDID - Easy EDID Creator
6.12.Control Menu
6.12.1.Ethernet
6.12.2.GPIO
6.12.3.RS-232
6.13.Settings Menu
6.13.1.Status
6.13.2.Network
6.13.3.Services
6.13.4.Power
6.13.5.System
6.14.Advanced View Window
7.Software Control - BlueRiver AV Manager
7.1.Introduction
7.2.Installation
7.3.Software User Guide
8.Lightware REST API Reference
8.1.Overview
8.2.Instructions for the Terminal Application Usage
8.2.1.Web Browser Plugins
8.2.2.Third-party API Platform
8.2.3.Terminal Application
8.3.Protocol Rules
8.3.1.Command Structure Example
8.3.2.General Rules
8.3.3.Legend for the Control Commands
8.3.4.Lightware REST API vs. LW3 Protocol
8.3.5.Method Types
8.3.6.Supported Commands
8.3.7.Not Supported Commands
8.3.8.Status Codes, Error Messages
8.3.9.Polling
8.4.REST API Security
8.4.1.Authentication
8.4.2.Encryption (HTTPS)
8.5.System Commands
8.5.1.Setting the Device Label
8.5.2.Resetting the Device
8.5.3.Restoring the Factory Default Settings
8.5.4.Querying the Firmware Package Version
8.5.5.Control Lock
8.5.6.Setting the Current Time
8.5.7.Identifying the Device
8.5.8.Toggling the Dark Mode Setting
8.5.9.Setting the Delay of the Dark Mode
8.5.10.Enabling Remote System Logging
8.5.11.Setting the Remote Server Address
8.5.12.Setting the Protocol for the Remote System Logging
8.5.13.Setting the Format of the Remote System Logging
8.5.14.Setting the Port for Remote System Logging
8.5.15.Enabling/Disabling SNMP Monitoring
8.5.16.Setting the Device Location
8.5.17.Setting the SNMP Authentication
8.6.Video Port Settings - General
8.6.1.Switching the Video Input
8.6.2.Switching an Input to All Outputs
8.6.3.Locking the Video Port
8.6.4.Muting the Video Port
8.6.5.Setting the Autoselect Policy
8.6.6.Changing the Autoselect-Included Input Ports
8.6.7.Changing the Input Port Priority
8.6.8.Querying the Connected Source
8.6.9.Querying the Connected Destinations
8.6.10.Querying the Input Switching Capability
8.6.11.Query the Video Signal Presence
8.6.12.HDCP Setting (Input Port)
8.6.13.HdcpMode
8.6.14.Querying the Embedded Audio Presence
8.6.15.Muting the Embedded Audio
8.6.16.Setting the Output Signal Type
8.6.17.Turning on Output 5V
8.7.Welcome Screen Settings
8.7.1.Displaying the Welcome Screen Image
8.7.2.Displaying the Welcome Screen Text
8.7.3.Setting the Welcome Screen Text
8.7.4.Resetting the Welcome Screen Image
8.8.Video Port Settings - USB-C Related Commands
8.8.1.Restarting the Link Training
8.9.CEC Command Sending
8.9.1.Simple CEC Code Sending
8.9.2.Remote Control Code Sending
8.10.Audio Port Settings
8.10.1.Switching the Audio Input
8.10.2.Querying the Connected Source
8.10.3.Querying the Connected Destinations
8.10.4.Setting the Autoselect Operation Mode
8.10.5.Setting the Followed Video Port to Autoselect
8.10.6.Locking the Audio Port
8.10.7.Muting the Audio Port 1.
8.10.8.Muting the Audio Port 2.
8.10.9.Querying the Audio Signal Presence
8.10.10.Analog Audio Output Volume (dB) Setting
8.10.11.Analog Audio Output Volume Percent Setting
8.10.12.Setting the Balance
8.10.13.Analog Audio Output Level Setting by Steps (dB)
8.10.14.Analog Audio Output Level Setting by Steps in Percent
8.10.15.Analog Audio Output Balance Setting by Steps
8.11.USB Port Settings
8.11.1.Switching the USB Input
8.11.2.Querying the Connected Source
8.11.3.Querying the Connected Destinations
8.11.4.Locking the USB Port
8.11.5.Setting the 5V Sending to the USB Peripherals
8.11.6.Setting the USB Autoselect Policy
8.11.7.Setting the Followed Video Port to Autoselect
8.11.8.Changing the Autoselect Included USB Ports
8.11.9.Changing the USB Port Priority
8.12.USB Port Settings - USB-C Related Commands
8.12.1.Setting the USB-C Power
8.12.2.Setting the Displayport Alternate Mode Policy
8.12.3.Querying the Host Alternate Mode Support
8.12.4.Querying the Status of the Alternate Mode
8.12.5.Querying the Port Data Role
8.12.6.Querying the Port Power Role
8.12.7.Setting the Port Power Role
8.13.EDID Management
8.13.1.Querying the Emulated EDIDs
8.13.2.Querying the Validity of a Dynamic EDID
8.13.3.Querying the Preferred Resolution of a User EDID
8.13.4.Emulating an EDID to an Input Port
8.13.5.Emulating an EDID to All Input Ports
8.13.6.Copying an EDID to User Memory
8.13.7.Deleting an EDID from User Memory
8.13.8.Resetting the Emulated EDIDs
8.14.Ethernet Port Configuration
8.14.1.Setting the DHCP State
8.14.2.Changing the IP Address (Static)
8.14.3.Changing the Subnet Mask (Static)
8.14.4.Changing the Gateway Address (Static)
8.14.5.Applying the Network Settings
8.14.6.Setting the Hostname
8.15.Network Security
8.15.1.Enabling/Disabling the Ethernet Port
8.15.2.Querying the Network Service Port Number
8.15.3.Enabling/Disabling the Network Service Port
8.15.4.Querying the Username for Authentication
8.15.5.Setting a Password for Authentication
8.15.6.Enabling the Authentication
8.15.7.Setting the VLAN Preset
8.15.8.Setting the VLAN ID
8.15.9.Setting up the Static IP Address for Management Network
8.15.10.Setting Up the Gateway for Static IP Connection on the Management Network
8.16.Serial Port Configuration
8.16.1.BAUD Rate Setting
8.16.2.Stop Bits Setting
8.16.3.Querying the Data Bits
8.16.4.Parity Setting
8.16.5.Querying the Serial over IP Port Number
8.16.6.Enabling the Serial over IP Port
8.17.Serial Port Messaging
8.17.1.Sending a Message via RS-232
8.18.GPIO Port Configuration
8.18.1.Setting the Direction of a GPIO Pin
8.18.2.Setting the Output Level of a GPIO Pin
8.18.3.Setting the Output Level for a Specified Time
8.18.4.Toggling the Level of a GPIO Pin
8.19.Updating the Device via REST API
8.19.1.Querying the Update REST API Version
8.19.2.The Updating Process
8.19.3.Uploading the Package
8.19.4.Configuration Parameters – Keep the Current Settings
8.19.5.Configuration Parameters - Setting "Soft" Factory Reset
8.19.6.Configuration Parameters - Querying the Factory Reset Setting
8.19.7.Configuration Parameters - Deleting "Soft" Factory Reset Configuration
8.19.8.Executing the Update
8.19.9.Querying the State of the Updating Process
9.LW3 Programmers' Reference
9.1.Overview
9.2.Instructions for the Terminal Application Usage
9.3.Websocket (WS) or Secured Websocket (WSS) Usage
9.4.Protocol Rules
9.4.1.LW3 Tree Structure and Command Structure (examples)
9.4.2.General Rules
9.4.3.Legend for the Control Commands
9.4.4.Command Types
9.4.5.Prefix Summary
9.4.6.Error Messages
9.4.7.Escaping
9.4.8.Signature
9.4.9.Subscription
9.4.10.Notifications about the Changes of the Properties
9.5.System Commands
9.5.1.Setting the Device Label
9.5.2.Resetting the Device
9.5.3.Restoring the Factory Default Settings
9.5.4.Querying the Firmware Package Version
9.5.5.Control Lock
9.5.6.Setting the Current Time
9.5.7.Identifying the Device
9.5.8.Toggling the Dark Mode Setting
9.5.9.Setting the Delay of the Dark Mode Setting
9.5.10.Enabling Remote System Logging
9.5.11.Setting the Remote Server Address
9.5.12.Setting the Protocol for the Remote System Logging
9.5.13.Setting the Format of the Remote System Logging
9.5.14.Setting the Port for Remote System Logging
9.5.15.Enabling/Disabling SNMP Monitoring
9.5.16.Setting the Device Location
9.6.Video Port Settings - General
9.6.1.Switching Video Input
9.6.2.Switching an Input to All Outputs
9.6.3.Locking the Video Port
9.6.4.Muting the Video Port
9.6.5.Setting the Autoselect Policy
9.6.6.Changing the Autoselect Included Input Ports
9.6.7.Changing the Input Port Priority
9.6.8.Querying the Connected Source
9.6.9.Querying the Input Switching Capability
9.6.10.Querying the Connected Destinations
9.6.11.Querying the Video Signal Presence
9.6.12.HDCP Setting (Input Port)
9.6.13.HdcpMode
9.6.14.OutputSignalType
9.6.15.EmbeddedAudioPresent
9.6.16.EmbeddedAudioMute
9.6.17.Output5VMode
9.6.18.HDCP Capability (Output Port)
9.6.19.HDCP Setting (Output Port)
9.7.Welcome Screen Settings
9.7.1.Displaying the Welcome Screen Image
9.7.2.Displaying the Welcome Screen Text
9.7.3.Setting the Welcome Screen Text
9.7.4.Resetting the Welcome Screen Image
9.8.Video Port Settings - USB-C Related Commands
9.8.1.Restarting the Link Training
9.9.CEC Command Sending
9.9.1.Simple CEC Code Sending
9.9.2.Remote Control Code Sending
9.10.Audio Port Settings
9.10.1.Switching the Audio Input
9.10.2.Querying the Connected Source
9.10.3.Querying the Connected Destinations
9.10.4.Setting the Autoselect Operation Mode
9.10.5.Setting the Followed Video Port to Autoselect
9.10.6.Locking the Audio Port
9.10.7.Muting the Audio Port 1.
9.10.8.Muting the Audio Port 2.
9.10.9.Querying the Audio Signal Presence
9.10.10.Analog Audio Output Volume (dB) Setting
9.10.11.Analog Audio Output Volume Percent Setting
9.10.12.Setting the Balance
9.10.13.Analog Audio Output Level Setting by Steps (dB)
9.10.14.Analog Audio Output Level Setting by Steps in Percent
9.10.15.Analog Audio Output Balance Setting by Steps
9.11.USB Port Settings
9.11.1.Switching the USB Input
9.11.2.Querying the Connected Source
9.11.3.Querying the Connected Destinations
9.11.4.Locking the USB Port
9.11.5.Setting the 5V Sending to the USB Peripherals
9.11.6.Setting the USB Autoselect Policy
9.11.7.Setting the Followed Video Port to Autoselect
9.11.8.Changing the Autoselect Included USB Ports
9.11.9.Changing the USB Port Priority
9.11.10.Setting the Icron Role Automation Mode
9.12.USB Port Settings - USB-C Related Commands
9.12.1.Setting the USB-C Power
9.12.2.Setting the Power Allocation Mode
9.12.3.Setting the Displayport Alternate Mode Policy
9.12.4.Querying the Host Alternate Mode Support
9.12.5.Querying the Status of the Alternate Mode
9.12.6.Querying the Port Data Role
9.12.7.Querying the Port Power Role
9.12.8.Setting the Port Power Role
9.13.EDID Management
9.13.1.Querying the Emulated EDIDs
9.13.2.Querying the Validity of a Dynamic EDID
9.13.3.Querying the Preferred Resolution of a User EDID
9.13.4.Emulating an EDID to an Input Port
9.13.5.Emulating an EDID to All Input Ports
9.13.6.Copying an EDID to User Memory
9.13.7.Deleting an EDID from User Memory
9.13.8.Resetting the Emulated EDIDs
9.14.Ethernet Port Configuration
9.14.1.Setting the DHCP State
9.14.2.Changing the IP Address (Static)
9.14.3.Changing the Subnet Mask (Static)
9.14.4.Changing the Gateway Address (Static)
9.14.5.Applying the Network Settings
9.14.6.Setting the Host name
9.15.Network Security
9.15.1.Enabling/Disabling the Ethernet Port
9.15.2.Querying the Service Port Number
9.15.3.Enabling/Disabling the Service Port
9.15.4.Querying the Username for Authentication
9.15.5.Enabling the Authentication
9.15.6.Restatring the Network Services
9.15.7.Setting the VLAN Preset
9.15.8.Setting the VLAN ID
9.15.9.Setting up the Static IP Address for Management Network
9.15.10.Setting Up the Gateway for Static IP Connection on the Management Network
9.16.Serial Port Configuration
9.16.1.BAUD Rate Setting
9.16.2.Stop Bits Setting
9.16.3.Querying the Data Bits
9.16.4.Parity Setting
9.17.Sending a Message via RS-232
9.18.GPIO Port Configuration
9.18.1.Querying the Direction of a GPIO Pin
9.18.2.Setting the Direction of a GPIO Pin
9.18.3.Querying the Output Level of a GPIO Pin
9.18.4.Setting the Output Level of a GPIO Pin
9.18.5.Setting the Output Level for a Specified Time
9.18.6.Toggling the Level of a GPIO Pin
10.Firmware Update
10.1.Introduction
10.2.Preparation
10.2.1.Reserved Ports of the SDVoE Control Server
10.2.2.About the Firmware Package (LFP2 File)
10.2.3.LDU2 Installation
10.3.Running the Software
10.4.Updating Via GUI
10.5.Command Line Interface (CLI)
10.5.1.How to Run
10.5.2.How to Use
10.6.CLI Commands
10.6.1.Help
10.6.2.LDU2 Version
10.6.3.Check For New LDU2 Version
10.6.4.Device Info
10.6.5.Update
10.6.6.Package Options
10.6.7.Complex Example
10.6.8.Exit Codes
10.7.Updating via REST API
10.8.If the Update is not successful
11.Troubleshooting
11.1.Use Case Studies
11.2.How to Speed Up the Troubleshooting Process
12.Technologies
12.1.EDID Management
12.1.1.Understanding the EDID
12.1.2.Advanced EDID Management
12.2.AV Over IP
12.3.HDCP Management
12.3.1.Protected and Unprotected Content
12.3.2.Disable Unnecessary Encryption
12.3.3.HDCP 2.2
12.4.Pixel Accurate Reclocking
13.Appendix
13.1.Specifications
13.1.1.UCX-4x3-TPN-TX20, UCX-2x1-TPN-TX20, DCX-3x1-TPN-TX10
13.2.Port Numbering
13.3.Applied Ports (Network Settings)
13.4.Factory EDID List
13.5.Cable Wiring Guide
13.5.1.Serial Ports
13.5.2.Audio Ports
13.6.Factory Default Settings
13.7.Content of the Backup File
13.8.LARA Package Compatibility by Firmware
13.9.Mechanical Drawings
13.10.Firmware Release Notes for UCX-TX Devices
13.11.Known Issues
13.12.Hashtag Keyword List
13.13.Further Document Information
13.14.Limited Warranty Statement
UCX-TPN_series
