Lightware UCX-2x1-HC30 User Manual
  1. Manuals
  2. Brands
  3. Lightware Manuals
  4. Switch
  5. UCX-2x1-HC30
  6. User manual

Lightware UCX-2x1-HC30 User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

User's Manual
UCX-2x1-HC30, UCX-2x2-H30
UCX-4x2-HC30, UCX-4x2-HC30D
Universal Switcher
v1.5
02-07-2021

Advertisement

Table of Contents
loading

Related Manuals for Lightware UCX-2x1-HC30

Summary of Contents for Lightware UCX-2x1-HC30

  • Page 1 User’s Manual UCX-2x1-HC30, UCX-2x2-H30 UCX-4x2-HC30, UCX-4x2-HC30D Universal Switcher   v1.5 02-07-2021...
  • Page 2     UCX series – User's Manual Important Safety Instructions Waste Electrical & Electronic Equipment Common Safety Symbols WEEE Class II apparatus construction. Symbol Description This marking shown on the product or its literature, The equipment should be operated only from the power source indicates that it should not be disposed with other indicated on the product.
  • Page 3 The following symbols and markings are used in the document: All presented functions refer to the indicated products. The descriptions Lightware Visual Engineering supports green technologies and have been made during testing these functions in accordance with the Eco-friend mentality. Thus, this document is made for digital usage...

  • Page 4: Table Of Contents

    5.12.1. Device Cloning – Configuration Backup and Restore ....44 7.2.2. Terminal Application ............... 71 4.1.3. Ventillation ..................22 7.3. Protocol Rules ................72 6. SOFTWARE CONTROL - LIGHTWARE DEVICE CONTROLLER ..45 4.2. Electrical Connections ..............23 7.3.1. Command Structure Example ............72 4.2.1. HDMI Input and Output Ports ............23 6.1. Install and Update ..............46...
  • Page 5 7.18.3. Querying the Reported OCS State ..........99 7.7.1. Display Welcome Screen Image ............. 81 7.12.1. Query the Emulated EDIDs ............90 7.19. Lightware REST API Quick Summary........100 7.7.2. Display Welcome Screen Text ............81 7.12.2. Query the Validity of a Dynamic EDID .......... 90 7.7.3. Set Welcome Screen Text ............... 81 7.12.3. Query the Preferred Resolution of a User EDID ......
  • Page 6     UCX series – User's Manual 8. LW3 PROGRAMMERS’ REFERENCE ..........104 8.6.15. EmbeddedAudioMute ..............113 8.11.7. Set Port Power Role ..............122 8.6.16. OutputSignalType ................ 114 8.12. EDID Management ..............123 8.1. Overview ..................105 8.6.17. Output5VMode ................114 8.12.1. Query the Emulated EDIDs ............123 8.2. Instructions for the Terminal Application Usage ....105 8.7. Welcome Screen Settings ............114 8.12.2. Query the Validity of a Dynamic EDID ........
  • Page 7     UCX series – User's Manual 8.19. LW3 Commands - Quick Summary ...........132 12.7. Applied Ports (Network Settings) .........162 12.8. Firmware Release Notes ............163 9. FIRMWARE UPDATE ..............136 12.9. Hashtag Keyword List ............165 9.1. Introduction ................137 12.10. Further Information .............166 9.2. Preparation ................137 9.2.1. About the Firmware Package (LFP2 File) ........137 9.2.2. LDU2 Installation ................

  • Page 8: Introduction

    1. Introduction UCX series – User's Manual I ntroduction Thank you for choosing Lightware’s The Taurus UCX-series devices. In the first chapter we would like to introduce the device highlighting the most important features in the below listed sections: ç Description ç...

  • Page 9: Description

    1.1. Description 1.2. Box Contents Lightware’s universal switcher enhances and extends the possibilities of a meeting room and allows meeting participants to easily use their own devices such as laptops, and preferred video conference platforms while also to utilize the available assets of the meeting space, just like the HDMI displays, room cameras and other USB peripherals.

  • Page 10: Features Of The Device

    Basic IT-security* #new These entry-level network security improvements help to prevent unauthorized access to the Lightware device: HTTPS/WSS support, basic network authentication. Bi-directional RS-232* #new RS-232 AV systems can also contain serial port controllers and controlled devices. Serial transmission supports any unit that works with standard RS-232.

  • Page 11: Model Comparison

    Utility Configurable Purpose In Out Sensor (5 Gbps) HDMI HDMI embedding AES67 audio (5 Gbps) (5 Gbps) Ethernet Ethernet Ethernet RS-232 (GPIO) (OCS) UCX-2x1-HC30        UCX-2x2-H30        ...

  • Page 12: Typical Application

        1. Introduction UCX series – User's Manual 1.6. Typical Application UCX-4x2-HC30 - Example 2. UCX-4x2-HC30 - Example 1. Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1...

  • Page 13: Product Overview

        2. Product Overview UCX series – User's Manual Product Overview The following sections are about the physical structure of the device, input/ output ports and connectors: ç Front View ç Rear View Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1...

  • Page 14: Front View

        2. Product Overview UCX series – User's Manual 2.1. Front View UCX-2x1-HC30 1 2 3 Configurable Ethernet RJ45 connector for configurable 100Base-T Ethernet communication. Port USB-A Port The firmware update function will be added by future firmware update.

  • Page 15: Rear View

       2. Product Overview UCX series – User's Manual 2.2. Rear View UCX-2x1-HC30 5 6 7 DC Input The device can be powered by an external 120W power supply. Connect the output to the 2-pole Phoenix connector. For more info about the powering, ®...

  • Page 16: Front Panel Control

        3. Front Panel Control UCX series – User's Manual Front Panel Control The following sections are about front panel operation of the device and the status LEDs: ç Button Functionality ç Status LEDs Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1...

  • Page 17: Button Functionality

    Push OUT2 to select the video input for the HDMI OUT2 port. Step 2. Power on the switcher while the VIDEO OUT2 (VIDEO IN2 in UCX-2x1-HC30 model) is being pressed for 10 seconds. The device restores the factory default settings and reboots.

  • Page 18: Control Lock

    3.1.4. Control Lock Press the VIDEO OUT1 ( VIDEO OUT1 (VIDEO IN1 in in UCX-2x1-HC30 model) ) and AUDIO OUT buttons together (within 100 ms) USB Host connected and selected. to disable/enable front panel buttons; front panel LEDs blink 4 times when locking/unlocking. If the control lock is enabled and a button is pressed, front panel LEDs blink 3 times quickly.

  • Page 19: Ethernet Status Leds

        3. Front Panel Control UCX series – User's Manual 3.2.3. Ethernet Status LEDs 3.2.4. Dante Audio Out (in UCX-4x2-HC30D model) ® Left LED HW version color DIFFERENCE: The color of the left Ethernet LED is red DIFFERENCE: UCX-4x2-HC30D model has Dante Audio Output.

  • Page 20: Installation

        4. Installation UCX series – User's Manual Installation ç Mounting Options ç Electrical Connections ç Powering Options ç Power Delivery ç USB-C Cable Recommendation ç Connecting Steps Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1...

  • Page 21: Mounting Options

    The examples demonstrate the applications of UD Kit accessories: To mount the switcher Lightware supplies optional accessories for different usage. There are two kinds of mounting kits with similar fixing method. The switcher has two mounting holes with inner thread on Step 1.

  • Page 22: Ventillation

        4. Installation UCX series – User's Manual Step 4. Fix the UD Mounting plate F100 and UD Mounting PSU F100 under the desk by fastening the screws. INFO: UD Mounting plate F100 and UD Mounting PSU F100 do not contain the fixing screws, they can be purchased from the local hardware store.

  • Page 23: Electrical Connections

    Wiring of LAN Cables The pinout of the USB-C connector Lightware recommends the termination of LAN cables on the basis of TIA/EIA T 568 A or TIA/EIA T 568 B ATTENTION! USB-C functionality and speed depend on the cable and the device. Mandatory features of standards.

  • Page 24: Ocs Connector

        4. Installation UCX series – User's Manual 4.2.5. OCS Connector 4.2.6. GPIO - General Purpose Input/Output Ports The switcher is supplied a 3.81mm 3-pole 90° Reversed Gender Plug Phoenix connector which is used for The switcher is supplied a 8-pole Phoenix connector with six GPIO pins, which operates at TTL digital signal ®...

  • Page 25: Connector

        4. Installation UCX series – User's Manual 4.2.7. RS-232 Connector Supported power profiles: 5V/3A, 9V/3A, 15V/2A, 20V/1,5A The switcher contains a 3-pole Phoenix connector which is used for RS-232 serial connection. #new Pin nr. Signal Ground TX data RX data RS-232 connector pin assignments RS-232 Output Voltage Levels...

  • Page 26: Power Data Objects (Usb-C)

        4. Installation UCX series – User's Manual USB Chargers Dual-Role Power USB-C PD covers a range of different power levels, with different amperage and voltage combinations that With USB-C the connector is the same on all products. Laptops, certain tablets and smartphones can be a charger can deliver, depending on what the device asks for and the cable negotiates.

  • Page 27: Connecting Steps

        4. Installation UCX series – User's Manual 4.6. Connecting Steps Room PC Connect a USB-C source (e.g. BYOD laptop) to the USB-C input port. USB-C BYOD BYOD The applied cable shall be certified for USB 3.1 Gen1 (5Gbps) and Displayport Alternate mode Speaker Laptop 1.

  • Page 28: Device Concept

        5. Device Concept UCX series – User's Manual Device Concept The following chapter describes the features of the device with a few real-life examples. ç Universal Switcher Concept ç USB Interface ç Video Interface ç The Autoselect Feature ç...

  • Page 29: Universal Switcher Concept

    VBUS TX1- TX1+ GND USB Superspeed Data Channel 5 Gbps Lightware’s universal switcher exploits the USB-C connectivity for a simplified transmission of 4K video, USB High Speed Data Channel 480 Mbps audio, control signals and power providing meeting participants with easy host switching, utilizing data speeds of up to 5 Gbps under the USB 3.1 Gen1 providing video supporting up to 4k@60Hz at 4:4:4 video...

  • Page 30: Usb Data - Usb 3.1 Gen1 Interface

    (5 Gbps) Diagram. INFO: USB.2.x and 3.x data transfer happens on two independent layers simultaneously. USB Features UCX-2x1-HC30 DisplayPort Alternate Mode UCX-2x2-H30 This function is available only for USB type C connectors. See more details in DisplayPort Alternate Mode UCX-4x2-HC30 section.

  • Page 31: Usb Service Ports - Usb 2.0 Interface

    5.2.3. USB Service Ports - USB 2.0 Interface Summary of USB 2.0 ports Service ports USB-A mini USB- B USB 2.0 USB 2.0 (480 Mbps) (480 Mbps) UCX-2x1-HC30   UCX-2x2-H30   UCX-4x2-HC30   USB features in Taurus UCX series UCX-4x2-HC30D ...

  • Page 32: Video Interface

    Analog UCX-2x1-HC30 de-embedder converter HDMI in I2 audio out UCX-2x2-H30 *UCX-2x1-HC30 model has USB-C input. UCX-4x2-HC30 5.3.1. DisplayPort Alternate Mode UCX-4x2-HC30D USB-C sources sends Displayport signal for video transmission. Displayport Alternate mode allows using the DisplayPort Alternate Mode Video Port Diagram (UCX-4x2-HC30D)

  • Page 33: Displayport Alternate Mode And Usb 3.X Mixed

    (e.g. I1 priority:1; I2 priority:2; I3 priority:3; I4 priority:4; I5 priority:5 ). ATTENTION! The autoselect function remains active after the manual crosspoint switching. This operation mode works contrary to the other Lightware matrix switchers or extenders). Disable autoselect The crosspoint state change only happens manually.
  • Page 34     5. Device Concept UCX series – User's Manual Last detect BYOD laptop 1. (I1) is displayed on Monitor 1. (O1) and BYOD device 2. (I2) can be seen on Monitor 2. when they are connected and send active video signal.The individual input settings are the following: Always the last attached input is selected to transmit.
  • Page 35 I4 (HDMI in 4) I3 (HDMI in 3) BYOD Laptop I1 (USB-C in 1) Priorities can be set in Lightware Device Controller software, see related settings in the HDMI Video Output section. Automatic Input Selection - Example 4. The individual input settings are the following: O1: I1 priority:1;...
  • Page 36     5. Device Concept UCX series – User's Manual Case 3. When the BYOD laptop uses HDMI for video and USB-B for data. When the BYOD laptop uses USB-C for video and data and USB-C for data. Case 2.

  • Page 37: Audio Interface

    AES67 source over the dedicated RJ45 ® connector. The chosen audio signal is mirrored to the analog audio port. #dante #audio UCX-2x1-HC30   The same signal is sent to both analog and Dante audio outputs. Both can be muted at the same time by changing O3 port setting in the audio crosspoint: /MEDIA/AUDIO/XP/O3.Mute...
  • Page 38     5. Device Concept UCX series – User's Manual Settings and Signal Routing Device Settings The discovered Dante -compatible devices are displayed with middle-blue color. Double-click on the name ® to open the device settings. The default device name is: UCX-D-<Dante_MAC_address_last 6_characters>...

  • Page 39: Ethernet Interface

    5.6. Ethernet Interface The device can be controlled via Ethernet (standard RJ45 connector). This interface supports: ▪ Configure the device with Lightware Device Controller. For more information about the LDC, see Summary of Ethernet ports Software Control - Lightware Device Controller section.

  • Page 40: Basic Network Security

        5. Device Concept UCX series – User's Manual 5.7. Basic Network Security 5.7.2. HTTP/HTTPS UCX series switcher provides HTTP/HTTPS server services on its 80 (for HTTP) and 443 (for HTTPS) ports. DIFFERENCE: The basic network security feature is available only from FW package v1.2.0. It makes possible to use the following services via HTTP/HTTPS: #new These basic network security improvements help to prevent unauthorized access to the UCX series switchers:...

  • Page 41: Encryption (Https, Wss)

    ▪ The UCX series switcher generates a self-signed certificate, so the user does not have to deal with Step 2. Enable the authentication on the chosen port (HTTP: 80 or HTTPS: 443) with Lightware Device the configuration. Controller software (Network) or LW3 protocol command (Enable Authentication).

  • Page 42: Websocket Service (Ws, Wss)

    Set Password for Authentication Enable Authentication section). Step 4. Disable 6107 port, use Lightware REST API HTTPS (443 port) or WSS for LW3 protocol for control the device. ATTENTION! Lightware Device Controller software operates on 6107 port, in this case the UCX series switcher can be controlled only with protocol commands.

  • Page 43: Serial Interface

    The MP1 (CPU) is available over REST API interface. The MP1 (CPU) sends the message via the serial port, UCX-2x2-H30 to a third-party (or a Lightware) device. This is a one-way communication, the response will not be interpreted by the CPU. Consider using Serial over IP function instead if listening to a serial device is important.

  • Page 44: Gpio Interface

    Menu, System tab in Lightware Device Controller Software. The script packages are created by Lightware, please contact your sales representative for help. When the occupancy sensor detects people in the meeting room, the UCX switcher turns on the ceiling lamp.

  • Page 45: Software Control - Lightware Device Controller

    S oftware Control - Lightware Device Controller The device can be controlled by a computer through Ethernet by the Lightware Device Controller (LDC). The software can be installed on a Windows PC or macOS. The application and the User’s Manual can be downloaded from www.lightware.com.

  • Page 46: Install And Update

    The Device Discovery window appears automatically and the program checks the available updates on The window can be zoomed to a specific value to fit to the resolution of the desktop (higher/lower). '1' is the Lightware’s website and opens the update window if LDC updates are found. default value (100%).

  • Page 47: Establishing The Connection

    Clicking on the icon results the blinking of the status LEDs for 10 seconds. The feature helps to find the as you can expand the list of Favorite devices with any Lightware device that is connected via Ethernet by any device itself physically.

  • Page 48: Ldc Layout

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.4. LDC Layout ATTENTION! Up to the v1.0.1b1 firmware version and v2.5.3b3 LDC version, the older LDC layout can be seen. From the 1.1.0b7 firmware version and v2.5.4b3 LDC the LDC design changed as it is seen in this chapter.

  • Page 49: Video & Audio Crosspoint

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.5. Video & Audio Crosspoint #crosspoint #switch Main menu The available menu items are displayed. The active one is showed with dark grey background color.

  • Page 50: Port Tiles

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.5.1. Port Tiles The colors of the port tiles and the displayed icons represent different states and information: Port name Port icon Port number Signal present...

  • Page 51: Port Properties Window

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.6. Port Properties Window General Clicking on the port tile opens the Port properties window. This section shows the available settings and Port name status information by port types.

  • Page 52: Usb-C Inputs

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.6.2. USB-C Inputs Allowed HDCP Version #hdcp ATTENTION! HDCP 2.2 signal handing is limited up to two input ports at the same time. Clicking on the USB-C video input port icon results opening the Port properties window. The most important information and settings are available from the panel.
  • Page 53     6. Software Control - Lightware Device Controller UCX series – User's Manual DisplayPort Link USB-C input port properties window INFO: The USB-C source sends Displayport video signal, so the video setting options of the USB-C port are similar to the DisplayPort.

  • Page 54: Hdmi Video Input

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.6.3. HDMI Video Input Available settings and tools Port name Clicking on the HDMI video input port icon results opening the Port properties window. The most important information and settings are available from the panel.

  • Page 55: Hdmi Video Output

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.6.4. HDMI Video Output Available settings and tools General Port name The name of a port can be changed by typing the new name and clicking on the Set button. The following characters are allowed when naming: Letters (A-Z) and (a-z), hyphen (-), underscore (_), numbers (0-9), and dot (.).

  • Page 56: Embedded Audio Input

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.6.5. Embedded Audio Input Autoselect Autoselect feature makes possible switching input to the output without human intervention. The crosspoint state changes the based on the active input signals.

  • Page 57: Analog Audio Output

    ▪ Volume: from 100 to 0%, in step 1% (0 dB to -95.625 dB, in step 0.375 dB (default is 0 dB)); Lightware’s Frame Detector function works like a signal analyzer and makes possible to determine the exact ▪ Balance: from -100 to +100, in step 1 (default is 0 = center).

  • Page 58: Usb Crosspoint

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.7. USB Crosspoint 6.7.1. USB-C Port Properties In USB crosspoint tab, the connection between the of the upstream ports (USB-C and USB-B ports) and the USB hub (USB-A ports) can be set.

  • Page 59: Usb-B Port Properties

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.7.2. USB-B Port Properties USB-C Power Limit Choose a powering option from the drop-down menu: #power ▪ Equal output power: both USB-C ports supplies max. 30W power.
  • Page 60     6. Software Control - Lightware Device Controller UCX series – User's Manual USB Hub Properties Autoselect #autoselect # usbautoselect For more details about this feature see Autoselect section. Autoselect settings: Disable autoselect / Follow video / First detect / Last detect mode / Individual input...

  • Page 61: Edid Menu

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.8. EDID Menu 6.8.1. EDID Operations Advanced EDID Management can be accessed by selecting the EDID menu. There are two panels: left one Changing Emulated EDID contains Source EDIDs, right one contains Destination places where the EDIDs can be emulated or copied.

  • Page 62: Edid Summary Window

    The software resolves the raw EDID and displays it as readable information to the user. All descriptors can be edited, and saved in an EDID file, or uploaded to the User memory. For more details about EDID Editor please visit our website (www.lightware.com) and download the EDID Editor Application note.

  • Page 63: Creating An Edid - Easy Edid Creator

    Since above mentioned Advanced EDID Editor needs more complex knowledge about EDID, 6.9.1. Ethernet Lightware introduced a wizard-like interface for fast and easy EDID creation. With Easy EDID Creator it is possible to create custom EDIDs in four simple steps. By clicking on the Create button below Source panel, Easy EDID Creator is opened in a new window.

  • Page 64: Gpio

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.9.2. GPIO Interval Interval section is designed for setting the chosen GPIO pin to the specified level for a specified time. DIFFERENCE: This feature is available only from FW package 1.1.0b7.

  • Page 65: Settings Menu

    #rs232 Serial Port Messaging Status tab in Settings menu ATTENTION! Serial message sending is implemented only via Lightware REST API. This function is not available with LDC or LW3 protocol command. For more details see Sending a Message via RS-232section.

  • Page 66: Network

    UCX series switcher provides HTTP/HTTPS server services on its 80 and 443 port to make accessible LW3 over WebSocket (WS), LW3 protocol, using Lightware Device Controller and REST API for device control (see the detailed list about the additional available features, in the summary table of the Basic Network Security section).

  • Page 67: System

    This feature is available only from FW package 1.0.1b1. This interface is for running custom zipped file which is made by Lightware for special request. Put a tick to enable the Run script. It means, that the script runs until the uploading another script or disable this function.

  • Page 68: Advanced View Window

        6. Software Control - Lightware Device Controller UCX series – User's Manual 6.11. Advanced View Window LW3 protocol help Pushing the button results a help window opening which describes the most important information about LW3 protocol commands in HTML format.

  • Page 69: Lightware Rest Api Reference

    ç USB Port Settings - USB-C Related Commands ç EDID Management ç Ethernet Port Configuration ç Network Security ç Serial Port Configuration ç Serial Port Messaging ç GPIO Port Configuration ç OCS Port Configuration ç Lightware REST API Quick Summary Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1...

  • Page 70: Overview

    Google Chrome - Advanced Rest Client The Lightware REST API is designed to provide a platform-free interface, where the UCX series switchers can be controlled by HTTP requests. REST API is a software architectural style based on HTTP protocol, so it can be used via web browser, Node.js, terminal programs.

  • Page 71: Terminal Application

        7. Lightware REST API Reference UCX series – User's Manual 7.2.2. Terminal Application GET Command Example The REST API requests can be applied to the switcher using a terminal application. You need to install one Query the Signal Presence of them to your control device, for example, Putty, CLI or Curl.

  • Page 72: Protocol Rules

        7. Lightware REST API Reference UCX series – User's Manual 7.3. Protocol Rules POST Command with Basic Authentication Example Switch video crosspoint 7.3.1. Command Structure Example curl --user <username>:<password> -X POST -i <ip>/api/<NodePath>/<PropertyName> --data <value> IP address or hostname of...

  • Page 73: Legend For The Control Commands

    The desired property value should be given as a plain text in the body of the request. The new value is in the body of the response. 7.3.4. Lightware REST API vs. LW3 Protocol Protocol Command All the methods and properties of the LW3 tree structure appears below /api as a HTTP(s) URL.

  • Page 74: Not Supported Commands

        7. Lightware REST API Reference UCX series – User's Manual 7.3.7. Not Supported Commands 7.4. REST API Security Query node (GET) The REST API is designed with two security features: Authentication and Encryption. Both of them are optional and can be used independently from each other.

  • Page 75: System Commands

        7. Lightware REST API Reference UCX series – User's Manual 7.5. System Commands 7.5.4. Querying the Firmware Package Version Request and Response #firmwareversion 7.5.1. Set the Device Label header: GET·http://<ip>/api/V1/MANAGEMENT/UID/PACKAGE/Version·HTTP/1.1 ɯ INFO: The device label can be changed to a custom text in the Status tab of the LDC software.

  • Page 76: Set Current Time

        7. Lightware REST API Reference UCX series – User's Manual 7.5.6. Set Current Time Example header: POST http://192.168.0.50/api/V1/MANAGEMENT/UI/DARKMODE/Enable HTTP/1.1 Request and Response #time ɯ body: true ɯ header: POST·http://<ip>/api/V1/MANAGEMENT/DATETIME/setTime·HTTP/1.1 ɯ header: 200 OK body: <current_time> ɮ ɯ...

  • Page 77: Video Port Settings - General

        7. Lightware REST API Reference UCX series – User's Manual 7.6. Video Port Settings - General 7.6.3. Lock the Video Port Request and Response 7.6.1. Switch Video Input header: POST·http://<ip>/api/V1/MEDIA/VIDEO/XP/<port>/Lock·HTTP/1.1 ɯ Request and Response body: <locked_state> ɯ header: POST·http://<ip>/api/V1/MEDIA/VIDEO/XP/switch·HTTP/1.1 ɯ...

  • Page 78: Set The Autoselect Policy

        7. Lightware REST API Reference UCX series – User's Manual 7.6.5. Set the Autoselect Policy 7.6.7. Change the Input Port Priority Request and Response Request and Response header: POST·http://<ip>/api/V1/MEDIA/VIDEO/AUTOSELECT/<out>/Policy·HTTP/1.1 header: POST·http://<ip>/api/V1/MEDIA/VIDEO/AUTOSELECT/<out>/<in>/Priority·HTTP/1.1 ɯ ɯ body: <autoselect_mode> body: <prio_num> ɯ...

  • Page 79: Query The Input Switching Capability

        7. Lightware REST API Reference UCX series – User's Manual 7.6.10. Query the Input Switching Capability 7.6.12. HDCP Setting (Input Port) Video crosspoint has a limitation: I1 or I5 ports can not be selected to any output at the same time. Busy HDCP capability can be set on the input ports, thus, non-encrypted content can be seen on a non-HDCP value of the switchable property refers to the limitation.

  • Page 80: Query Embedded Audio Presence

        7. Lightware REST API Reference UCX series – User's Manual 7.6.16. Set Output Signal Type Example header: POST http://192.168.0.50/api/V1/MEDIA/VIDEO/O1/HDCP/HdcpMode HTTP/1.1 Request and Response #signaltype ɯ body: Auto ɯ header: POST·http://<ip>/api/V1/MEDIA/VIDEO/<out>/OutputSignalType·HTTP/1.1 ɯ header: 200 OK body: <signal_type> ɮ...

  • Page 81: Welcome Screen Settings

        7. Lightware REST API Reference UCX series – User's Manual 7.7. Welcome Screen Settings 7.7.3. Set Welcome Screen Text Request and Response 7.7.1. Display Welcome Screen Image header: POST·http://<ip>/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/MessageText·HTTP/1.1 ɯ Request and Response #welcomescreen body: <text> ɯ header: POST·http://<ip>/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/ImageEnabled·HTTP/1.1 ɯ...

  • Page 82: Video Port Settings - Usb-C Related Commands

        7. Lightware REST API Reference UCX series – User's Manual 7.8. Video Port Settings - USB-C Related Commands 7.9.2. Query the Connected Source Request and Response 7.8.1. Restart Link Training header: GET·http://<ip>/api/V1/MEDIA/AUDIO/XP/O3/ConnectedSource·HTTP/1.1 ɯ This method is equal with pulling out and plug in again the USB-C connector.

  • Page 83: Set Autoselect Operation Mode

        7. Lightware REST API Reference UCX series – User's Manual 7.9.4. Set Autoselect Operation Mode Parameter Parameter description Values Value description Request and Response <audio_port> Audio Port Audio input port number I1-I4 Audio output port number header: POST·http://<ip>/api/V1/MEDIA/AUDIO/AUTOSELECT/O3/Policy·HTTP/1.1...

  • Page 84: Mute The Audio Port 2

        7. Lightware REST API Reference UCX series – User's Manual 7.9.8. Mute the Audio Port 2. 7.9.10. Analog Audio Output Volume (dB) Setting INFO: The volume of the analog audio output is set to low. Request and Response...

  • Page 85: Setting The Balance

        7. Lightware REST API Reference UCX series – User's Manual 7.9.12. Setting the Balance 7.9.14. Analog Audio Output Level Settings by Steps in Percent Request and Response #balance Request and Response header: POST·http://<ip>/api/V1/MEDIA/AUDIO/O3/Balance·HTTP/1.1 header: POST·http://<ip>/api/V1/MEDIA/AUDIO/O3/stepVolumePercent·HTTP/1.1 ɯ ɯ body: <level>...

  • Page 86: Usb Port Settings

        7. Lightware REST API Reference UCX series – User's Manual 7.10.  USB Port Settings 7.10.3. Query the Connected Destinations Request and Response #autoselect 7.10.1. Switch USB Input header: GET·http://<ip>/api/V1/MEDIA/USB/XP/<host>/ConnectedDestinations·HTTP/1.1 ɯ Request and Response #usb header: 200·OK ɮ header: POST·http://<ip>/api/V1/MEDIA/USB/XP/switch<host>/H1·HTTP/1.1...

  • Page 87: Setting The 5V Sending To The Usb Peripherals

        7. Lightware REST API Reference UCX series – User's Manual 7.10.5. Setting the 5V Sending to the USB Peripherals Example header: POST http://192.168.0.50/api/V1/MEDIA/USB/AUTOSELECT/H1/Policy HTTP/1.1 The 5V power towards the USB A-type ports can be enabled or disabled as follows: ɯ...

  • Page 88: Change The Usb Port Priority

        7. Lightware REST API Reference UCX series – User's Manual 7.10.9. Change the USB Port Priority 7.11.2. Set Displayport Alternate Mode Policy DIFFERENCE: This command is available only from FW package 1.1.0b7. Request and Response Request and Response header: POST·http://<ip>/api/V1/MEDIA/USB/<usb-c_port>/DpAltModePolicy·HTTP/1.1...

  • Page 89: Query The Host Alternate Mode Support

        7. Lightware REST API Reference UCX series – User's Manual 7.11.3. Query the Host Alternate Mode Support 7.11.5. Query the Port Data Role Request and Response Request and Response header: GET·http://<ip>/api/V1/MEDIA/USB/<usb-c_port>/HostSupportsDpAltMode·HTTP/1.1 header: GET·http://<ip>/api/V1/MEDIA/USB/<usb-c_port>/ActivePortDataRole·HTTP/1.1 ɯ ɯ header: 200·OK header: 200·OK...

  • Page 90: Set Port Power Role

        7. Lightware REST API Reference UCX series – User's Manual 7.11.7. Set Port Power Role 7.12.2. Query the Validity of a Dynamic EDID Request and Response Request and Response header: POST·http://<ip>/api/V1/MEDIA/USB/<usb-c_port>/PortPowerRoleSetting·HTTP/1.1 header: GET·http://<ip>/api/V1/EDID/D/D1/Validity·HTTP/1.1 ɯ ɯ body: <power_role> ɯ...

  • Page 91: Emulating An Edid To An Input Port

        7. Lightware REST API Reference UCX series – User's Manual 7.12.4. Emulating an EDID to an Input Port 7.12.6. Copy an EDID to User Memory Request and Response Request and Response header: POST·http://<ip>/api/V1/EDID/switch·HTTP/1.1 header: POST·http://<ip>/api/V1/EDID/copy·HTTP/1.1 ɯ ɯ body: <source>:<destination>...

  • Page 92: Resetting The Emulated Edids

        7. Lightware REST API Reference UCX series – User's Manual 7.12.8. Resetting the Emulated EDIDs Example header: POST http://192.168.0.50/api/V1/MANAGEMENT/NETWORK/DhcpEnabled HTTP/1.1 Request and Response ɯ body: true ɯ header: POST·http://<ip>/api/V1/EDID/reset·HTTP/1.1 ɯ header: 200 OK ɮ INFO: The body has to be empty, and the content type should be text/plain.

  • Page 93: Change The Subnet Mask (Static)

        7. Lightware REST API Reference UCX series – User's Manual 7.13.3. Change the Subnet Mask (Static) 7.13.5. Apply Network Settings Request and Response #ipaddress Request and Response header: POST·http://<ip>/api/V1/MANAGEMENT/NETWORK/StaticNetworkMask·HTTP/1.1 header: POST·http://<ip>/api/V1/MANAGEMENT/NETWORK/applySettings·HTTP/1.1 ɯ ɯ body: <netmask> ɯ INFO: The body has to be empty, and the content type should be text/plain.

  • Page 94: Network Security

    <status> The port is enabled. true Identifier Parameter description Parameter values The port is disabled. false HTTP *The UCX-2x1-HC30 model has three Ethernet port (P1-P3). <port> Port type HTTPS Example <status> The port is enabled. true The port is disabled.

  • Page 95: Set Password For Authentication

        7. Lightware REST API Reference UCX series – User's Manual 7.14.5. Set Password for Authentication 7.14.6. Enable Authentication INFO: Due to security reasons, the password is not stored in any property, so it can not be queried. No INFO: Set the password before enable the authentication, because no password is set for default.

  • Page 96: Serial Port Configuration

    19200 <serial_port> Serial port number P1-P2* 38400 57600 <databits> DataBits value 115200 *The UCX-2x1-HC30 model has one serial port (P1). *The UCX-2x1-HC30 model has one serial port (P1). Example Example header: POST http://192.168.0.50/api/V1/MEDIA/SERIAL/P1/Baudrate HTTP/1.1 header: GET http://192.168.0.50/api/V1/MEDIA/SERIAL/P1/DataBits HTTP/1.1 ɯ ɯ...

  • Page 97: Query The Serial Over Ip Port Number

    7.16. Serial Port Messaging Request and Response 7.16.1. Sending a Message via RS-232 header: GET·http://<ip>/api/V1/MEDIA/SERIAL/<serial_port>/SERIALOVERIP/Port·HTTP/1.1 ɯ ATTENTION! Serial message sending is implemented only via Lightware REST API. This function is not header: 200·OK available with LW3 protocol command. #message ɮ body: <port_nr>...

  • Page 98: Gpio Port Configuration

        7. Lightware REST API Reference UCX series – User's Manual 7.17. GPIO Port Configuration 7.17.3. Setting the Output Level for a Specified Time 7.17.1. Setting the Direction of a GPIO Pin Request and Response Request and Response header: POST·http://<ip>/api/V1/MEDIA/GPIO/<port>/interval·HTTP/1.1 ɯ...

  • Page 99: Ocs Port Configuration

        7. Lightware REST API Reference UCX series – User's Manual 7.18. OCS Port Configuration 7.18.3. Querying the Reported OCS State Request and Response 7.18.1. Querying the Input Level of an OCS Pin header: GET·http://<ip>/api/V1/MEDIA/OCS/P1/State·HTTP/1.1 ɯ Request and Response #ocs header: 200·OK...

  • Page 100: Lightware Rest Api Quick Summary

        7. Lightware REST API Reference UCX series – User's Manual 7.19. Lightware REST API Quick Summary body: <locked_state> ɯ Mute the Video Port System Commands header: POST·http://<ip>/api/V1/MEDIA/VIDEO/XP/<port>/Mute·HTTP/1.1 ɯ Set the Device Label body: <muted_state> ɯ header: POST·http://<ip>/api/V1/MANAGEMENT/LABEL/DeviceLabel·HTTP/1.1 Set the Autoselect Policy ɯ...
  • Page 101     7. Lightware REST API Reference UCX series – User's Manual Turn on Output 5V body: <locked_state> ɯ Mute the Audio Port 1. header: POST·http://<ip>/api/V1/MEDIA/VIDEO/<out>/Output5VMode·HTTP/1.1 ɯ body: <5V_pwr> ɯ header: POST·http://<ip>/api/V1/MEDIA/AUDIO/XP/<audio_port>/Mute·HTTP/1.1 ɯ body: <muted_state> Welcome Screen Settings ɯ...
  • Page 102     7. Lightware REST API Reference UCX series – User's Manual Lock the USB Port Set Port Power Role header: POST·http://<ip>/api/V1/MEDIA/USB/XP/<usb_port>/Lock·HTTP/1.1 header: POST·http://<ip>/api/V1/MEDIA/USB/<usb-c_port>/PortPowerRoleSetting·HTTP/1.1 ɯ ɯ body: <locked_state> body: <power_role> ɯ ɯ Setting the 5V Sending to the USB Peripherals...
  • Page 103     7. Lightware REST API Reference UCX series – User's Manual Change the Gateway Address (Static) Parity Setting header: POST·http://<ip>/api/V1/MANAGEMENT/NETWORK/StaticGatewayAddress·HTTP/1.1 header: POST·http://<ip>/api/V1/MEDIA/SERIAL/<serial_port>/Parity·HTTP/1.1 ɯ ɯ body: <gw_address> body: <parity> ɯ ɯ Apply Network Settings Query the Serial over IP Port Number header: POST·http://<ip>/api/V1/MANAGEMENT/NETWORK/applySettings·HTTP/1.1...

  • Page 104: Lw3 Programmers' Reference

    7. LW3 Programmers’ Reference UCX series – User's Manual 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 ç...

  • Page 105: Overview

    WebSocket Service (WS, WSS) section. 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. The LW3 node tree is available after opening a session with the device on the following path: 8.2. Instructions for the Terminal Application Usage...

  • Page 106: Protocol Rules

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.4. Protocol Rules 8.4.3. Legend for the Control Commands Command and Response – Example 8.4.1. LW3 Tree Structure and Command Structure (examples) ç GET·/V1/MEDIA/VIDEO/I2.SignalPresent  / pr·/V1/MEDIA/VIDEO/I2.SignalPresent=<signal_present> æ  V1 ...

  • Page 107: Command Types

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.4.4. Command Types 8.4.5. Prefix Summary DEFINITION: The prefix is a 2-character long code that describes the type of the response. GET command The following prefixes are defined in the LW3 protocol: The GET command can be used to get the child nodes, properties and methods of a specific node.

  • Page 108: Signature

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.4.8. Signature 8.4.10. Notifications about the Changes of the Properties DEFINITION: The signature is a four-digit-long hexadecimal value that can be optionally placed before When the value of a property is changed and the user is subscribed to the node, which the property belongs every command to keep a command and the corresponding responses together as a group.

  • Page 109: System Commands

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.5. System Commands 8.5.4. Querying the Firmware Package Version Command and Response #firmwareversion 8.5.1. Set the Device Label ç GET·/V1/MANAGEMENT/UID/PACKAGE.Version INFO: The device label can be changed to a custom text in the Status tab of the LDC software.

  • Page 110: Identifying The Device

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.5.7. Identifying the Device 8.6. Video Port Settings - General Calling the method makes the status LEDs blink for 10 seconds. The feature helps to find the device physically. 8.6.1. Switch Video Input Command and Response #identifyme...

  • Page 111: Lock The Video Port

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.6.3. Lock the Video Port 8.6.5. Set the Autoselect Policy Command and Response Command and Response SET·/V1/MEDIA/VIDEO/XP/<port>.Lock=<locked_state> SET·/V1/MEDIA/VIDEO/AUTOSELECT/<out>.Policy=<autoselect_mode> ç ç pw·/V1/MEDIA/VIDEO/XP/<port>.Lock=<locked_state> pw·/V1/MEDIA/VIDEO/AUTOSELECT/<out>.Policy=<autoselect_mode> æ æ Parameters Parameters Parameter Parameter description Values Value description Parameter...

  • Page 112: Change The Input Port Priority

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.6.7. Change the Input Port Priority 8.6.9. Query the Connected Destinations Command and Response Command and Response SET·/V1/MEDIA/VIDEO/AUTOSELECT/<out>/<in>.Priority=<prio_num> ç GET·/V1/MEDIA/VIDEO/XP/<n>.ConnectedDestinations ç pw·/V1/MEDIA/VIDEO/AUTOSELECT/<out>/<in>.Priority=<prio_num> pr·/V1/MEDIA/AUDIO/XP/<in>.ConnectedDestinations=<out> æ æ Example Parameters ç GET /V1/MEDIA/VIDEO/XP/I3.ConnectedDestinations <prio>...

  • Page 113: Hdcp Setting (Input Port)

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.6.12. HDCP Setting (Input Port) 8.6.14. EmbeddedAudioPresent HDCP capability can be set on the input ports, thus, non-encrypted content can be seen on a non-HDCP ç GET·/V1/MEDIA/VIDEO/<port>.EmbeddedAudioPresent compliant display. See more information in the HDCP Management section.

  • Page 114: Outputsignaltype

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.6.16. OutputSignalType 8.7. Welcome Screen Settings Command and Response #signaltype 8.7.1. Display Welcome Screen Image SET·/V1/MEDIA/VIDEO/<out>.OutputSignalType=<signal_type> ç Command and Response #welcomescreen pw·/V1/MEDIA/VIDEO/<out>.OutputSignalType=<signal_type> æ SET·/V1/MEDIA/VIDEO/I5/WELCOMESCREEN.ImageEnabled=<image_state> ç Parameters pw·/V1/MEDIA/VIDEO/I5/WELCOMESCREEN.ImageEnabled=<image_state æ Parameter Parameter description Values Value description Parameters <signal_type>...

  • Page 115: Reset Welcome Screen Image

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.7.4. Reset Welcome Screen Image 8.9. Audio Port Settings This command restores the original welcome screen image. 8.9.1. Switch Audio Input Command and Response Command and Response ç CALL·/V1/MEDIA/VIDEO/I5/WELCOMESCREEN:resetImage() ç CALL·/V1/MEDIA/AUDIO/XP:switch(<audio_in>:O3) æ...

  • Page 116: Query The Connected Destinations

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.9.3. Query the Connected Destinations 8.9.5. Set the Followed Video Port to Autoselect Command and Response Command and Response ç GET·/V1/MEDIA/AUDIO/XP/<audio_in>.ConnectedDestinations SET·/V1/MEDIA/AUDIO/AUTOSELECT/O3.VideoFollowPort=<out> ç æ pr·/V1/MEDIA/AUDIO/XP/<audio_in>.ConnectedDestinations= pw·/V1/MEDIA/AUDIO/AUTOSELECT/O3.VideoFollowPort=<out> ç Example Parameters ç...

  • Page 117: Mute The Audio Port 2

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.9.10. Analog Audio Output Volume (dB) Setting INFO: All inputs and analog output ports have a mute property in the audio XP (e.g. /V1/MEDIA/AUDIO/ XP/I1.Mute). Outputs have a separate mute function within the port node as well: Command and Response #analogaudio #volume...

  • Page 118: Analog Audio Output Level Settings By Steps (Db)

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.9.13. Analog Audio Output Level Settings by Steps (dB) 8.10. USB Port Settings Command and Response #analogaudio #volume 8.10.1. Switch USB Input CALL·/V1/MEDIA/AUDIO/O3:stepVolumedB(<step>) ç Command and Response #usb æ m0·/V1/MEDIA/AUDIO/O3:stepVolumedB= ç...

  • Page 119: Query The Connected Destinations

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.10.3. Query the Connected Destinations 8.10.5. Setting the 5V Sending to the USB Peripherals Command and Response #autoselect The 5V power towards the USB A-type ports can be enabled or disabled as follows: ç...

  • Page 120: Set The Usb Autoselect Policy

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.10.6. Set the USB Autoselect Policy Example ç SET /V1/MEDIA/USB/AUTOSELECT/H1/U1.Included=true DIFFERENCE: Last detect and first detect mode is available only from FW package 1.1.0b7. æ pw /V1/MEDIA/USB/AUTOSELECT/H1/U1.Included=true Command and Response 8.10.9. Change the USB Port Priority SET·/V1/MEDIA/USB/AUTOSELECT/H1.Policy=<op_mode>...

  • Page 121: Usb Port Settings - Usb-C Related Commands

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.11. USB Port Settings - USB-C Related Commands 8.11.3. Query the Host Alternate Mode Support Command and Response 8.11.1. Set USB-C Power ç GET·/V1/MEDIA/USB/<usb-c_port>.HostSupportsDpAltMode Command and Response #power pr·/V1/MEDIA/USB/<usb-c_port>.HostSupportsDpAltMode=<altmode_support> æ SET·/V1/SYS/MB/USBCPOWER.PowerLimit=<power>...

  • Page 122: Query The Port Data Role

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.11.5. Query the Port Data Role 8.11.7. Set Port Power Role Command and Response Command and Response ç GET·/V1/MEDIA/USB/<usb_port>.ActivePortDataRole SET·/V1/MEDIA/USB/<usb-c_port>.PortPowerRoleSetting=<power_role> ç pr·/V1/MEDIA/USB/<usb_port>.ActivePortDataRole=<data_role> pw·/V1/MEDIA/USB/<usb_port>.PortPowerRoleSetting=<power_role> æ æ Parameters Parameters Parameter Parameter Parameter description Values Value description...

  • Page 123: Edid Management

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.12. EDID Management 8.12.4. Emulating an EDID to an Input Port Command and Response 8.12.1. Query the Emulated EDIDs ç CALL·/V1/EDID:switch(<source>:<destination>) Command and Response #edid æ mO·/V1/EDID:switch ç GET·/V1/EDID.EdidStatus Parameters æ...

  • Page 124: Copy An Edid To User Memory

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.12.6. Copy an EDID to User Memory 8.12.8. Resetting the Emulated EDIDs Command and Response Command and Response ç CALL·/V1/EDID:copy(<source>:<destination>) ç CALL·/V1/EDID:reset() æ mO·/V1/EDID:copy æ mO·/V1/EDID:reset Parameters Parameters Parameter Parameter description Values Value description...

  • Page 125: Ethernet Port Configuration

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.13. Ethernet Port Configuration 8.13.3. Change the Subnet Mask (Static) Command and Response #ipaddress 8.13.1. Set the DHCP State SET·/V1/MANAGEMENT/NETWORK.StaticNetworkMask=<netmask> ç ATTENTION! When you change a network property the new value is stored but the applySettings method pw·/V1/MANAGEMENT/NETWORK.StaticNetworkMask=<netmask>...

  • Page 126: Setting The Hostname

    The port is enabled. true Parameters The port is disabled. false Identifier Parameter description Parameter values *The UCX-2x1-HC30 model has three Ethernet port (P1-P3), UCX-2x2-H30 model has one (P1-P3). HTTP <port> Port type Example HTTPS <status> The port is enabled.

  • Page 127: Query The Username For Authentication

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.14.4. Query the Username for Authentication 8.14.6. Enable Authentication DIFFERENCE: This command is available from 1.2.0 firmware package. DIFFERENCE: This command is available from 1.2.0 firmware package. INFO: UCX series deal with one user for authentication and the username (admin) can not be changed. INFO: Set the password before enable the authentication, because no password is set for default.

  • Page 128: Serial Port Configuration

    Parameter Identifier Parameter values <databits> DataBits value description <serial_port> Serial port P1-P2* number *The UCX-2x1-HC30 model has one serial port (P1). <baudrate> Baud rate value 9600 19200 Example 38400 ç GET /V1/MEDIA/SERIAL/P1.DataBits 57600 æ pr /V1/MEDIA/SERIAL/P1.DataBits=8 115200 8.15.4. Parity Setting *The UCX-2x1-HC30 model has one serial port (P1).

  • Page 129: Query The Serial Over Ip Port Number

    <value> The output value of the GPIO pin. high level High ATTENTION! Serial message sending is implemented only via Lightware REST API. This function is not low level available with LW3 protocol command. For more details see Serial Port Messaging.

  • Page 130: Setting The Output Level Of A Gpio Pin

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.17.4. Setting the Output Level of a GPIO Pin 8.18. OCS Port Configuration Command and Response DIFFERENCE: Occupancy sensor-related commands are available only from FW package 1.1.0b7. ç SET·/V1/MEDIA/GPIO/<port>.Output(<value>) 8.18.1. Querying the Input Level of an OCS Pin æ...

  • Page 131: Querying The Reported Ocs State

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.18.3. Querying the Reported OCS State Command and Response ç GET·/V1/MEDIA/OCS/P1.State pr·/V1/MEDIA/OCS/P1.State=<status> æ Parameters Parameter Parameter description Value Value description <status> It reports the occupancy Free When the SensorType=Active high and the state of the room depending Inputlevel=Low or on the sensor type.

  • Page 132: Lw3 Commands - Quick Summary

        7. LW3 Programmers’ Reference UCX series – User's Manual 8.19. LW3 Commands - Quick Summary Change the Autoselect Included Input Ports SET·/V1/MEDIA/VIDEO/AUTOSELECT/<out>/<in>.Included=<state> ç System Commands Change the Input Port Priority Set the Device Label SET·/V1/MEDIA/VIDEO/AUTOSELECT/<out>/<in>.Priority=<prio_num> ç SET·/V1/MANAGEMENT/LABEL.DeviceLabel=<custom_name> ç...
  • Page 133     7. LW3 Programmers’ Reference UCX series – User's Manual Reset Welcome Screen Image Analog Audio Output Level Settings by Steps in Percent ç CALL·/V1/MEDIA/VIDEO/I5/WELCOMESCREEN:resetImage() CALL·/V1/MEDIA/AUDIO/O3:stepVolumePercent(<step>) ç Analog Audio Output Balance by Steps Video Port Settings - USB-C Related Commands CALL·/V1/MEDIA/AUDIO/O3:stepBalance(<step>) ç...
  • Page 134     7. LW3 Programmers’ Reference UCX series – User's Manual Query the Port Data Role Apply Network Settings ç GET·/V1/MEDIA/USB/<usb_port>.ActivePortDataRole ç CALL·/V1/MANAGEMENT/NETWORK:applySettings() Query the Port Power Role Setting the Hostname ç GET·/V1/MEDIA/USB/<usb_port>.ActivePortPowerRole SET·/V1/MANAGEMENT/NETWORK.HostName=<unique_name> ç Set Port Power Role Network Security #new SET·/V1/MEDIA/USB/<usb-c_port>.PortPowerRoleSetting=<power_role>...
  • Page 135     7. LW3 Programmers’ Reference UCX series – User's Manual Enable the Serial over IP Port SET·/V1/MEDIA/SERIAL/<serial_port>/SERIALOVERIP.Enabled=<state> ç Sending a Message via RS-232 #new GPIO Port Configuration Querying the Direction of a GPIO Pin ç GET·/V1/MEDIA/GPIO/<port>.Direction Setting the Direction of a GPIO Pin ç...

  • Page 136: Firmware Update

    This chapter is meant to help customers perform firmware updates on our products by giving a few tips on how to start and by explaining the features of the Lightware Device Updater v2 (LDU2) software. To get the latest software and firmware pack can be downloaded from www.lightware.com.

  • Page 137: Introduction

    If any problem occurs, reboot the device and restart the process. Available for Windows, 9.1. Introduction Available for Windows macOS and Linux Lightware Device Updater v2 (LDU2) software is the second generation of the LFP-based The installer can update Cannot be updated (Lightware Firmware Package) firmware update process. only this instance...

  • Page 138: Running The Software

    At startup, the software checks if a newer version is available on the web. Main Screen When the software is started by the shortcut, the device discovery screen SEARCH FOR DEVICES appears. Press the Search for devices button to start finding the Lightware devices: Legend of the Icons IP address editor The IP address of the device can be changed in the pop-up window.

  • Page 139: Updating Via Gui

    WARNING! UCX-4x2-HC30D model is supported above v1.1.0b7 firmware package. UCX-2x1-HC30, UCX-2x2-H30 models are supported above v1.2.0 firmware package. Please do not downgrade the device with a not compatible firmware package, because it can cause malfunction in the device.
  • Page 140     9. Firmware Update UCX series – User's Manual Step 2. Select the desired devices for upgrading. When the progress bar reaches 100% (Done is displayed at all devices), the update of all devices are finished successfully and a message appears; you can close the software. Select the devices for upgrading;...

  • Page 141: Command Line Interface (Cli)

    Step 1. Open an Explorer window where the cmd file is located, the default is: simoultaneously, when one of them is finished, the following (21st) will be started automatically. c:\Program Files (x86)\Lightware\Lightware Device Updater V2\LightwareDeviceUpdaterV2_CLI.cmd. ▪ If an update is failed, the IP address of the affected device(s) are listed at the end.

  • Page 142: Ldu2 Version

    Example C:\Program Files (x86)\Lightware\Lightware Device Updater V2>LightwareDeviceUpdaterV2_CLI.cmd deviceInfo --ip C:\Program Files (x86)\Lightware\Lightware Device Updater V2>LightwareDeviceUpdaterV2_CLI.cmd version 192.168.0.100 C:\Program Files (x86)\Lightware\Lightware Device Updater V2>lib\jre\bin\java.exe -jar lib\ldu2.jar deviceInfo --ip C:\Program Files (x86)\Lightware\Lightware Device Updater V2>lib\jre\bin\java.exe -jar lib\ldu2.jar version 192.168.0.100 LDU2 version: 2.10.0b6...

  • Page 143: Update

    C:\Program Files (x86)\Lightware\Lightware Device Updater V2>LightwareDeviceUpdaterV2_CLI.cmd update --ip 192.168.0.52 --package f:\!!!LIGHTWARE\firmware\taurus_v1.2.0b9.lfp2 --user admin --pw 4x2 --reportProgress C:\Program Files (x86)\Lightware\Lightware Device Updater V2>lib\jre\bin\java.exe -jar lib\ldu2.jar update --ip 192.168.0.52 --package f:\!!!LIGHTWARE\firmware\taurus_v1.2.0b7.lfp2 --reportProgress C:\Program Files (x86)\Lightware\Lightware Device Updater V2>lib\jre\bin\java.exe -jar lib\ldu2.jar update --ip [2021-06-17 08:53:01.250] [ INFO] [...

  • Page 144: Exit Codes

    If an update is not successful, the Export log button becomes red. If you press the button, you can download [2021-07-01 08:37:03.871] [ INFO] [ProgressReporter] - Progress: 82% the log file as a ZIP package which can be sent to Lightware Support if needed. The log files contain useful [2021-07-01 08:37:08.875] [ INFO] [ProgressReporter] - Progress: 86% information about the circumstances to find the root cause.

  • Page 145: Troubleshooting

        10. Troubleshooting UCX series – User's Manual Troubleshooting Usually, if the system seems not to transport the signal as expected, the best strategy for troubleshooting is to check signal integrity through the whole signal chain starting from source side and moving forward to receiver end. At first, check front panel LEDs and take the necessary steps according to their states.

  • Page 146: Use Case Studies

        10. Troubleshooting UCX series – User's Manual 10.1. Use Case Studies Symptom Root cause Action Refer to The source is Check the documentation of the source, and Symptom Root cause Action Refer to not able to send the ability of the connected port.

  • Page 147: How To Speed Up The Troubleshooting Process

    60W UCX series maximum power capacity is 60W. The more of the above information you can give us the better. Please send these information to the Lightware BYOD charges Support Team (support@lightware.com) to speed up the troubleshooting process.

  • Page 148: Technologies

        11. Technologies UCX series – User's Manual Technologies The following sections contain descriptions and useful technical information how the devices work in the background. The content is based on experiences and cases we met in the practice. These sections help to understand features and technical standards like the followings: ç...

  • Page 149: Edid Management

    (static EDID emulation), or from the last attached monitor’s memory (dynamic EDID emulation). For example, the Lightware device can be set up to emulate a sink device, which is connected to one of the outputs. In this case, the EDID automatically changes, if the monitor is replaced with another display device (as long as it has a valid EDID).

  • Page 150: Hdcp Management

    To avoid unnecessary HDCP encryption, Lightware introduced the HDCP enabling/disabling function: the Not HDCP-compliant Sink 2. HDCP capability can be disabled in the Lightware device. If HDCP is disabled, the connected source will The layout is the same as in the previous case: non-HDCP compliant display device is connected to the detect that the sink is not HDCP capable, and turn off authentication.

  • Page 151: Hdcp V2.2

    Output Lightware device. A lower level of encryption may be applied only if the source device/content allows it - according to the HDCP standard. In this case the HDCP setting on the input port has to be set to HDCP 1.4 HDCP v1.4...

  • Page 152: Pixel Accurate Reclocking

    Without reclocking, sparkles, noise, and jaggies appear on the image. Lightware’s sophisticated Pixel Accurate Reclocking technology fixes more problems than general TMDS reclocking. It removes not only intra-pair skew but inter-pair skew as well. The Pixel Accurate Reclocking...

  • Page 153: Appendix

        12. Appendix UCX series – User's Manual Appendix Tables, drawings, guides, technical details and hashtag keyword list as follows: ç Specifications ç Port Numbering Factory EDID List ç ç Cable Wiring Guide ç Mechanical Drawings ç Factory Default Settings ç...

  • Page 154: Specifications

    Supported power source ....................100-240 V AC; 50/60 Hz Audio formats ..................all formats in line with HDMI 2.0 standard Power consumption UCX-2x1-HC30 (max / min) ................90W / 5.3 W 3D support ................................yes Power consumption UCX-2x2-H30 (max / min)................26W / 3.9 W HDMI input Power consumption UCX-4x2-HC30 (max / min) ................105W/ 6.2 W...
  • Page 155     12. Appendix UCX series – User's Manual Supported audio formats for pass-through ..............All HDMI2.0 audio formats Control Ports Supported audio formats for de-embedding ................Uncompressed Ethernet port ..................LPCM (up to 8 channels, 192 kHz, 24 bits per sample) Connector type .........................

  • Page 156: Feature And Model Availability

        12. Appendix UCX series – User's Manual 12.1.1. Feature and Model Availability Firmware Feature package Supports UCX-2x1-HC30 and     UCX-2x2-H30 models Bi- directional RS-232     Authentication     Https/WSS support ...

  • Page 157: Port Numbering

        12. Appendix UCX series – User's Manual 12.2. Port Numbering GPIO Audio/Video Ports Port name Port nr. (LW3) Video port nr. Audio port nr. GPIO1 Port name (LW3) (LW3) GPIO2 USB-C in 1 GPIO3 USB-C in 2 GPIO4 HDMI in 3 GPIO5...

  • Page 158: Factory Edid List

        12. Appendix UCX series – User's Manual 12.3.  Factory EDID List Mem. Resolution Type Mem. Resolution Type Mem. Resolution Type Mem. Resolution Type 1280 x 720 @ 50.00 Hz F112 3840 x 2160 @ 30.00 Hz F148 3840 x 2160 @ 60.00 Hz RB, ALL...

  • Page 159: Cable Wiring Guide

    Symmetric audio is most often referred to as balanced audio, as opposed to asymmetric, which is referred to as unbalanced audio. Lightware products are usually built with 5-pole Phoenix connectors so we would like to help users assembling their own audio cables. See the most common cases below.

  • Page 160: Mechanical Drawings

        12. Appendix UCX series – User's Manual 12.5. Mechanical Drawings INFO: UCX-2x1-HC30, UCX-2x2-H30, UCX-4x2-HC30 models have the same size. Dimensions are in mm. UCX-2x1-HC30, UCX-2x2-H30, UCX-4x2-HC30 models Power supply 21.25 178.5 POWER LED Mounting hole Mounting hole...
  • Page 161     12. Appendix UCX series – User's Manual UCX-4x2-HC30D model 21.25 178.5 Mounting hole Mounting hole Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1...

  • Page 162: Factory Default Settings

    Device Discovery 224.0.0.251:5353 HDCP mode (in) - UCX-4x2-HC30(D) I1, I2: HDCP 1.4; I3,I4: HDCP 2.2 Remote IP 230.76.87.82:37421 HDCP mode (in) UCX-2x1-HC30, UCX-2x2-H30 I1, I2: HDCP 2.2 HDCP mode (out) Auto Power 5V Enable Emulated EDID on all four inputs...

  • Page 163: Firmware Release Notes

    Known issue: Type-C connectors, then the ActiveAltMode property erroneously reads as DP. /V1/MEDIA/USB/ UCX-2x1-HC30 and UCX-2x2-H30 are supported from FW 1.2.0. Uploading a FW package of version ▪ U1.ActiveAltMode=DP This issue causes Lightware Device Controller to erroneously display a yellow less than 1.2.0 renders these variants disfunctional.
  • Page 164 Type-C connectors, then the ActiveAltMode property erroneously reads as DP. /V1/MEDIA/USB/ switchAll(0) method does not work. switch(0:O1;0:O2) works as expected. U1.ActiveAltMode=DP This issue causes Lightware Device Controller to erroneously display a yellow ""DP"" indicator on the port panel, which means the connection successfully entered DisplayPort Known issue: Alterante mode.

  • Page 165: Hashtag Keyword List

    Source/destination port status query #dhcp #power Power sending settings This keyword is placed at the DHCP (dynamic IP address) setting in the front panel operation, the Lightware Device Controller (LDC) and the LW3 programmer's reference section. #producttype Product type query...

  • Page 166: Further Information

    Barsony chapter, add examples to autoselect 1.2. If during the first three (3) months of purchase, the customer is unhappy with any aspect of a Lightware description, add hashtags product, Lightware will accept a return for full credit.
  • Page 167 ©2021 Lightware Visual Engineering. All rights reserved. All trademarks mentioned are the property of their respective owners. Specifications subject to change without notice.

This manual is also suitable for:

Ucx-2x2-h30Ucx-4x2-hc30Ucx-4x2-hc30d

Table of Contents