Skip to main content

SensorInfo

Sensor metadata, containing the common fields shared by all types of sensors.

Attributes:

Attribute

Type

Description

id

str

Unique sensor identifier, e.g. "imu_main_1", "head"

sensor_type

SensorType

Sensor category, see "Robot Metadata / SensorType"

model

str

Vendor model identifier, e.g. "IMU_MODEL_HI13R4N", "CAMERA_Model_BOOSTER_MIPI"

extra

dict[str, object]

Extension information field, currently an empty dict, reserved for future extensions

SensorInfo​

Signature:

SensorInfo(
*,
id: str,
sensor_type: SensorType,
model: str,
extra: dict[str, object] = {},
)

Description:

Constructs a SensorInfo instance. This type is an immutable dataclass and only supports keyword arguments.

Parameters:

Parameter

Type

Required

Description

id

str

Yes

Unique sensor identifier

sensor_type

SensorType

Yes

Sensor category, "imu" or "camera"

model

str

Yes

Vendor model identifier

extra

dict[str, object]

No

Extension field, defaults to an empty dict

Returns:

A SensorInfo instance.

Exceptions:

None.

Example:

# IMU sensor
imu = SensorInfo(
id="imu_main_1",
sensor_type="imu",
model="IMU_MODEL_HI13R4N",
)

# Camera sensor
camera = SensorInfo(
id="head",
sensor_type="camera",
model="CAMERA_Model_BOOSTER_MIPI",
)