System Commands; Set The Device Label; Querying The Product Name; Query The Firmware Package Version - Lightware UBEX-PRO20-HDMI-F110 User Manual

 
     
7. Programmers' Reference 7. Programmers' Reference
7.3. System Commands
7.3.1. Set the Device Label
INFO:
The device label can be changed to a custom text in the
Command and Response #devicelabel #label
SET•/MANAGEMENT/LABEL.DeviceLabel=<Custom_name>
ç
pw•/MANAGEMENT/LABEL.DeviceLabel=<Custom_name>
æ
The Device Label can be 39 characters long and ASCII characters are allowed. Longer names will be
truncated.
Example
ç SET /MANAGEMENT/LABEL.DeviceLabel=UBEX-RX_Conference
æ pw /MANAGEMENT/LABEL.DeviceLabel=UBEX-RX_Conference
7.3.2. Querying the Product Name
ATTENTION!
The name of the product is a read-only parameter and cannot be modified.
Command and Response
ç GET•/.ProductName
pr•/.ProductName=<Product_name>
æ
Example
ç GET /.ProductName
æ pr /.ProductName=UBEX-PRO20-HDMI-F110
7.3.3. Query the Firmware Package Version
Command and Response #firmwareversion
ç GET•/MANAGEMENT/UID/PACKAGE.Version
æ pr•/MANAGEMENT/UID/PACKAGE.Version
Example
ç GET /MANAGEMENT/UID/PACKAGE.Version
æ pr /MANAGEMENT/UID/PACKAGE.Version=v1.4.1b2
Status Tab of the LDC software.
=<firmware_version>
Applied F-series endpoint firmware package: v1.4.1 | Applied R-series endpoint firmware package: v1.4.1 | LDC software: v1.34.0b2
UBEX series – Extender Application Mode – User's Manual UBEX series – Extender Application Mode – User's Manual
7.3.4. Display Custom Text on the LCD
Calling the method makes a custom message
display on the LCD screen for 5 seconds. This
feature can be used to help to identify the device
itself in the rack shelf.
ATTENTION!
Applying of escaping is required in this method. See the details about it in the
section.
INFO:
The following characters are not allowed in the
Command and Response
ç CALL•/MANAGEMENT/UI:displayMessage(<text>)
æ mO•/MANAGEMENT/UI:displayMessage
Example
ç CALL /MANAGEMENT/UI:displayMessage(I'm here!)
æ mO /MANAGEMENT/UI:displayMessage
7.3.5. Display Custom Color on the LCD
Calling the method makes a custom color on the
LCD screen until withdrawal. This feature can be
used to help to identify the device itself in the rack
shelf.
Command and Response
ç CALL•/MANAGEMENT/UI:testDisplay(<mode>,<hex_code>)
æ mO•/MANAGEMENT/UI:testDisplay
Parameters
Identifier
<mode>
<hex_code>
Example
ç CALL /MANAGEMENT/UI:testDisplay(1,FFFF00)
æ mO /MANAGEMENT/UI:testDisplay
Explanation
The LCD screen displays whole colored yellow.
<text> parameter: ( ) { } # % \\ \r \n \t
Parameter description Value
0 The feature is disabled.
Enable or disable the
feature
1 The feature is enabled.
6 character long
RGB color
hexadecimal RGB color RGB color code
code
code
76 76
Escaping
Explanation