7. Lightware REST API Reference
UCX series – User's Manual
76
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.5.6.
Set Current Time
Request and Response
#time
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/DATETIME/setTime·HTTP/1.1
ɯ
body:
<current_time>
ɮ
header: 200·OK
ɮ
body: OK
Parameters
<current_time>:
The new router time in ISO 8601 date time format.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/DATETIME/setTime HTTP/1.1
ɯ
body: 2034-05-06T14:47:25
ɮ
header:
200 OK
ɮ
body: OK
7.5.7.
Identifying the Device
Calling the method makes the status LEDs blink for 10 seconds. The feature helps to find the device physically.
Request and Response
#identifyme
ɯ
header:
POST http://
<ip>
/api/V1/MANAGEMENT/UI/identifyMe·HTTP/1.1
INFO:
The body has to be empty, and the content type should be text/plain.
ɮ
header:
200 OK
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/UI/identifyMe HTTP/1.1
ɮ
header:
200 OK
7.5.8.
Toggling the Dark Mode Setting
The LEDs of the device can be switched off, if their light could be annoying. In Dark mode, all the LEDs are
switched off, except the LEDs of the RJ45 connectors (Ethernet and TPS in).
#darkmode
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/UI/DARKMODE/Enable·HTTP/1.1
ɯ
body:
<mode_state>
ɮ
header:
200 OK
ɮ
body:
<mode_state>
Parameters
If the
<mode_state>
parameter is
true
(or
1
), the Dark mode function is
enabled
, if the parameter is
false
(or
0
),
the function is
disabled
.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/UI/DARKMODE/Enable HTTP/1.1
ɯ
body: true
ɮ
header:
200 OK
ɮ
body: true
7.5.9.
Setting the Delay of the Dark Mode
The Dark mode can be enabled rightaway, or after a certain time. Thus, the mode is enabled, if no buttons
are pressed meanwhile. Pressing any button brings back the status info on the LEDs without performing the
function of the button itself. The delay time can be set by this command.
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MANAGEMENT/UI/DARKMODE/Delay·HTTP/1.1
ɯ
body:
<delay_time>
ɮ
·header: 200 OK
ɮ
body:
<delay_time>
Parameters
The
<delay_time>
parameter means seconds, and the default value is 0. If set to 0, no delay is applied, and
the Dark mode can be enabled immediately by the
DarkModeEnable
property. This delay has an affect to the
wakeFromDarkMode
method as well.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MANAGEMENT/UI/DARKMODE/Delay HTTP/1.1
ɯ
body: 10
ɮ
header:
200 OK
ɮ
body: 10