Lightware UCX-2x1-HC30, User Manual

Page: 6 / 167

UCX series – User's Manual 6
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
8. LW3 PROGRAMMERS’ REFERENCE .............................................104
8.1. Overview ....................................................................................105
8.2. Instructions for the Terminal Application Usage ..................105
8.3. Instructions for the Websocket (WS) or Secured Websocket (WSS)
Usage ........................................................................................105
8.4. Protocol Rules .........................................................................106
8.4.1. LW3 Tree Structure and Command Structure (examples) ..........106
8.4.2. General Rules .................................................................................106
8.4.3. Legend for the Control Commands ..............................................106
8.4.4. Command Types ...........................................................................107
8.4.5. Prefix Summary .............................................................................107
8.4.6. Error Messages .............................................................................107
8.4.7. Escaping ........................................................................................ 107
8.4.8. Signature ........................................................................................ 108
8.4.9. Subscription ...................................................................................108
8.4.10. Notifications about the Changes of the Properties ..................108
8.5. System Commands .....................................................................109
8.5.1. Set the Device Label ......................................................................109
8.5.2. Reset the Device ............................................................................109
8.5.3. Restore the Factory Default Settings ...........................................109
8.5.4. Querying the Firmware Package Version .....................................109
8.5.5. Control Lock ................................................................................... 109
8.5.6. Set Current Time ............................................................................109
8.5.7. Identifying the Device ....................................................................110
8.5.8. Toggling the Dark Mode Setting ...................................................110
8.5.9. Setting the Delay of the Dark Mode Setting .................................110
8.6. Video Port Settings - General ..................................................110
8.6.1. Switch Video Input ........................................................................110
8.6.2. Switch an Input to All Outputs ......................................................110
8.6.3. Lock the Video Port .......................................................................111
8.6.4. Mute the Video Port ......................................................................111
8.6.5. Set the Autoselect Policy ..............................................................111
8.6.6. Change the Autoselect Included Input Ports ...............................111
8.6.7. Change the Input Port Priority ......................................................112
8.6.8. Query the Connected Source ........................................................112
8.6.9. Query the Connected Destinations ...............................................112
8.6.10. Query the Input Switching Capability .........................................112
8.6.11. Query the Video Signal Presence ...............................................112
8.6.12. HDCP Setting (Input Port) ...........................................................113
8.6.13. HdcpMode ...................................................................................113
8.6.14. EmbeddedAudioPresent .............................................................113
8.6.15. EmbeddedAudioMute .................................................................113
8.6.16. OutputSignalType ........................................................................114
8.6.17. Output5VMode ............................................................................114
8.7. Welcome Screen Settings .........................................................114
8.7.1. Display Welcome Screen Image ...................................................114
8.7.2. Display Welcome Screen Text ......................................................114
8.7.3. Set Welcome Screen Text .............................................................114
8.7.4. Reset Welcome Screen Image ......................................................115
8.8. Video Port Settings - USB-C Related Commands ....................115
8.8.1. Restart Link Training .....................................................................115
8.9. Audio Port Settings ..................................................................115
8.9.1. Switch Audio Input ........................................................................115
8.9.2. Query the Connected Source ........................................................115
8.9.3. Query the Connected Destinations ...............................................116
8.9.4. Set Autoselect Operation Mode ...................................................116
8.9.5. Set the Followed Video Port to Autoselect ..................................116
8.9.6. Lock the Audio Port .......................................................................116
8.9.7. Mute the Audio Port 1. ..................................................................116
8.9.8. Mute the Audio Port 2. ..................................................................117
8.9.9. Query the Audio Signal Presence .................................................117
8.9.10. Analog Audio Output Volume (dB) Setting ...............................117
8.9.11. Analog Audio Output Volume Percent Setting ..........................117
8.9.12. Setting the Balance .....................................................................117
8.9.13. Analog Audio Output Level Settings by Steps (dB) ...................118
8.9.14. Analog Audio Output Level Settings by Steps in Percent .........118
8.9.15. Analog Audio Output Balance by Steps .....................................118
8.10. USB Port Settings ..................................................................118
8.10.1. Switch USB Input .........................................................................118
8.10.2. Query the Connected Source ......................................................118
8.10.3. Query the Connected Destinations ............................................119
8.10.4. Lock the USB Port .......................................................................119
8.10.5. Setting the 5V Sending to the USB Peripherals .........................119
8.10.6. Set the USB Autoselect Policy ....................................................120
8.10.7. Set the Followed Video Port to Autoselect ................................120
8.10.8. Change the Autoselect Included USB Ports ..............................120
8.10.9. Change the USB Port Priority ......................................................120
8.11. USB Port Settings - USB-C Related Commands .....................121
8.11.1. Set USB-C Power .........................................................................121
8.11.2. Set Displayport Alternate Mode Policy ......................................121
8.11.3. Query the Host Alternate Mode Support ...................................121
8.11.4. Query the Status of the Alternate Mode ....................................121
8.11.5. Query the Port Data Role ............................................................122
8.11.6. Query the Port Power Role ..........................................................122
8.11.7. Set Port Power Role ....................................................................122
8.12. EDID Management ...................................................................123
8.12.1. Query the Emulated EDIDs ..........................................................123
8.12.2. Query the Validity of a Dynamic EDID ........................................123
8.12.3. Query the Preferred Resolution of a User EDID .........................123
8.12.4. Emulating an EDID to an Input Port ............................................123
8.12.5. Emulating an EDID to All Input Ports .........................................123
8.12.6. Copy an EDID to User Memory ...................................................124
8.12.7. Deleting an EDID from User Memory .........................................124
8.12.8. Resetting the Emulated EDIDs ....................................................124
8.13. Ethernet Port Configuration ................................................125
8.13.1. Set the DHCP State .....................................................................125
8.13.2. Change the IP Address (Static) ..................................................125
8.13.3. Change the Subnet Mask (Static) ..............................................125
8.13.4. Change the Gateway Address (Static) .......................................125
8.13.5. Apply Network Settings ..............................................................125
8.13.6. Setting the Hostname .................................................................126
8.14. Network Security #new ................................................................. 126
8.14.1. Enable/Disable Ethernet Port .....................................................126
8.14.2. Query Service Port Number ........................................................126
8.14.3. Enable/Disable Service Port .......................................................126
8.14.4. Query the Username for Authentication ....................................127
8.14.5. Set Password for Authentication ...............................................127
8.14.6. Enable Authentication .................................................................127
8.14.7. Restart Network Services ...........................................................127
8.15. Serial Port Configuration .....................................................128
8.15.1. BAUD Rate Setting .......................................................................128
8.15.2. Stop Bits Setting ..........................................................................128
8.15.3. Query Data Bits ............................................................................128
8.15.4. Parity Setting ...............................................................................128
8.15.5. Query the Serial over IP Port Number ........................................129
8.15.6. Enable the Serial over IP Port .....................................................129
8.16. Sending a Message via RS-232 ................................................129
8.17. GPIO Port Configuration .......................................................129
8.17.1. Querying the Direction of a GPIO Pin .........................................129
8.17.2. Setting the Direction of a GPIO Pin ............................................129
8.17.3. Querying the Output Level of a GPIO Pin ...................................129
8.17.4. Setting the Output Level of a GPIO Pin ......................................130
8.17.5. Setting the Output Level for a Specified Time ...........................130
8.17.6. Toggling the Level of a GPIO Pin ................................................130
8.18. OCS Port Configuration .........................................................130
8.18.1. Querying the Input Level of an OCS Pin .....................................130
8.18.2. Set the Sensor Type ....................................................................130
8.18.3. Querying the Reported OCS State ..............................................131
   