7. Lightware REST API Reference
UCX series – User's Manual
89
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.11.3. Query the Host Alternate Mode Support
Request and Response
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/USB/
<usb-c_port>
/HostSupportsDpAltMode·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<altmode_support>
Parameters
Parameter
Parameter description
Value
Value description
<usb-c_port>
USB-C port number
U1-U2
USB-C port number
<altmode_support>
False
The host does not support the alternate mode.
True
The host supports the alternate mode.
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/USB/U1/HostSupportsDpAltMode HTTP/1.1
ɮ
header:
200 OK
ɮ
body: true
7.11.4. Query the Status of the Alternate Mode
Request and Response
#dpaltmode #alternatemode #displayportalternatemode
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/USB/
<usb-c_port>
/ActiveAltMode·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<altmode_state>
Parameters
Parameter
Parameter description
Value
Value description
<usb-c_port>
USB-C port number
U1-U2
USB-C port number
<altmode_state>
N/A
None
DP
The host is not connected
DP Alt mode is not active
DP Alt mode is active.
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/USB/U2/ActiveAltMode HTTP/1.1
ɮ
header:
200 OK
ɮ
body: DP
7.11.5. Query the Port Data Role
Request and Response
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/USB/
<usb-c_port>
/ActivePortDataRole·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<data_role>
Parameters
Parameter
Parameter
description
Values
Value description
<usb-c_port>
USB-C port number
U1-U2
USB-C port number
<data_role>
N/A
DFP
UFP
No
Downstream Facing Port (usually a Host / HUB ports)
The port data role is configured as USB Host. This is for
build-up the connection (USB data transmission operates
after the data role swap)
Upstream Facing Port (usually a device)
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/USB/U2/ActivePortDataRole HTTP/1.1
ɮ
header:
200 OK
ɮ
body: UFP
7.11.6. Query the Port Power Role
Request and Response
#power
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/USB/
<usb-c_port>
/ActivePortPowerRole·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<power_role>
Parameters
Parameter
Parameter description
Values
Value description
<usb-c_port>
USB-C port number
U1-U2
USB-C port number
<power_role>
N/A
Sink
Source
No information about the power role.
The port is configured as a sink.
The port is configured as a source
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/USB/U2/ActivePortPowerRole HTTP/1.1
ɮ
header:
200 OK
ɮ
body: Source
