HDBaseT Entity

API Documentation: [cpp] [python] [.NET] [CCA] [REST]

The HDBaseT entity provides link telemetry, remote-end USB topology discovery, and role control for the HDBaseT-USB3 link.

---

Identification

stem.system.getSerialNumber() [cpp] [python] [.NET] [LabVIEW]

Fills a caller-provided buffer with up to 6 bytes and reports the actual length unloaded.

stem.hdbaset.getFirmwareVersion() [cpp] [python] [.NET] [LabVIEW]

Returns a packed 32-bit value (Major: Bits 24-31; Minor: Bits 16-23; Patch: Bits 8-15; Build: Bits 0-7)

Link Status and Health

stem.hdbaset.getState() [cpp] [python] [.NET] [LabVIEW]

Returns a packed integer describing current link state.

stem.hdbaset.getCableLength() [cpp] [python] [.NET] [LabVIEW]

Perceived cable length in µm.

stem.hdbaset.getMSEA() [cpp] [python] [.NET] [LabVIEW]

stem.hdbaset.getMSEB() [cpp] [python] [.NET] [LabVIEW]

Mean Squared Error for channel A or B in µdB.

stem.hdbaset.getRetransmissionRate() [cpp] [python] [.NET] [LabVIEW]

Number of successful messages between retransmission; 0 = no errors, otherwise higher is better.

stem.hdbaset.getLinkUtilization() [cpp] [python] [.NET] [LabVIEW]

Link utilization in milli-percent (1000 = saturation).

stem.hdbaset.getEncodingState() [cpp] [python] [.NET] [LabVIEW]

Encoding state (e.g. PAM 8).

---

Remote USB Topology (Device Trees)

stem.hdbaset.getUSB2DeviceTree() [cpp] [python] [.NET] [LabVIEW]

stem.hdbaset.getUSB3DeviceTree() [cpp] [python] [.NET] [LabVIEW]

These calls return bytes describing the USB2/USB3 device trees at the HDBaseT endpoint.

---

Link Role Control

stem.hdbaset.getLinkRole() [cpp] [python] [.NET] [LabVIEW]

stem.hdbaset.setLinkRole() [cpp] [python] [.NET] [LabVIEW]

Role values are product/firmware specific (e.g., Auto Detect, Leader, Follower).

When in Auto Detect, the active role can be read using getState().