Lightware UCX Series, User Manual

Page: 63 / 109

7. LW3 Programmers’ Reference UCX series – User's Manual 63
Applied firmware package: v1.1.0b7 | LDC software: v2.5.4b3
7.4. System Commands
7.4.1. Set the Device Label
INFO: The device label can be changed to a custom text in the Status tab of the LDC software.
Command and Response #devicelabel #label
ç
SET·/V1/MANAGEMENT/LABEL.DeviceLabel= <custom_name>
æ
pw·/V1/MANAGEMENT/LABEL.DeviceLabel= <custom_name>
The Device Label can be 49 character length and ASCII characters are allowed. Longer names are truncated.
Example
ç
SET /V1/MANAGEMENT/LABEL.DeviceLabel=UCX_Conference_room1
æ
pw /V1/MANAGEMENT/LABEL.DeviceLabel=UCX_Conference_room1
7.4.2. Reset the Device
The switcher can be restarted – the current connections will be terminated.
Command and Response #reboot #restart
ç
CALL·/V1/SYS:restart()
æ
mO·/V1/SYS:restart=
Example
ç
CALL /V1/SYS:restart()
æ
mO /V1/SYS:restart=
7.4.3. Restore the Factory Default Settings
Command and Response
ç
CALL·/V1/SYS:factoryDefaults()
æ
mO·/V1/SYS:factoryDefaults=
Example
ç
CALL /V1/SYS:factoryDefaults()
æ
mO /V1/SYS:factoryDefaults=
The device is restarted, current connections are terminated, and the default settings are restored. See the
complete list in the Factory Default Settings section.
#factory
7.4.4. Querying the Firmware Package Version
Command and Response #firmwareversion
ç
GET·/V1/MANAGEMENT/UID/PACKAGE.Version
æ
pr·/V1/MANAGEMENT/UID/PACKAGE.Version= <firmware_version>
Example
ç
GET V1/MANAGEMENT/UID/PACKAGE.Version
æ
pr /V1/MANAGEMENT/UID/PACKAGE.Version=1.0.0b2
7.4.5. Control Lock
Enable/disable the operation of the front panel buttons.
Command and Response #lockbutton #buttonlock
ç
SET·/V1/MANAGEMENT/UI.ControlLock= <lock_status>
æ
pw·/V1/MANAGEMENT/UI.ControlLock= <lock_status>
Parameters
Parameter Parameter description Values Value description
<lock_status> Front panel button
locking status
None None:
all functions of the front panel button are enabled.
force
locked
The front panel buttons are locked and cannot be
unlocked by button combination, only in LDC (on the
Status tab) or using the LW3 command.
Example
ç
SET /V1/MANAGEMENT/UI.ControlLock=force locked
æ
pw /V1/MANAGEMENT/UI.ControlLock=force locked
7.4.6. Set Current Time
Command and Response #time
ç
CALL·/V1/MANAGEMENT/DATETIME:setTime( <current_time> )
æ
mO·/V1/MANAGEMENT/DATETIME:setTime=
Parameters
<current_time>: The new router time in ISO 8601 date time format.
Example
ç
CALL /V1/MANAGEMENT/DATETIME:setTime(2020-11-01T04:39:54.000Z)
æ
mO /V1/MANAGEMENT/DATETIME:setTime=
   