System Constants

This page aggregates system-related constants used by functions and methods from the C and C++ APIs.

GET_MANUFACTURER_STR

Request the USB manufacturer string descriptor.

GET_PRODUCT_STR

Request the USB product string descriptor.

GET_USB_SN_STR

Request the USB serial-number string descriptor.

GET_FW_VERSION

Request the firmware version string.

GET_HW_VERSION

Request the hardware version string.

group System-related constants

Enums

enum CdcMode

This enum represents the available modes for the USB CDC interface.

Values:

enumerator USB_CDC_UART_PASSTHROUGH

Transparent UART bridge.

enumerator USB_CDC_TERMINAL

Interactive I3C/I2C/GPIO serial shell (I3CBlaster emulator). Supernova only.

enumerator USB_CDC_NOVA_COMPAT

Binho Nova text protocol compatibility.

enumerator USB_CDC_RS485

RS-485 half-duplex bridge (SP3485CN). Pulsar only.

enumerator USB_CDC_CANFD

CAN-FD SLCAN bridge (TJA1044GT, python-can compatibility). Pulsar only.

enum WebusbState

This enum represents the available states for the WebUSB interface.

Values:

enumerator USB_WEBUSB_DISABLED

The WebUSB interface is disabled.

enumerator USB_WEBUSB_ENABLED

The WebUSB interface is enabled.

enumerator USB_WEBUSB_NO_CHANGE

No change to the WebUSB interface state. This value can be used when updating the USB configuration without modifying the WebUSB state.

enum CdcState

This enum represents the available states for the USB CDC interface.

Values:

enumerator USB_CDC_DISABLED

The USB CDC interface is disabled.

enumerator USB_CDC_ENABLED

The USB CDC interface is enabled.

enumerator USB_CDC_NO_CHANGE

No change to the USB CDC interface state. This value can be used when updating the USB configuration without modifying the USB CDC state.