Namespace nebula::drivers

Namespace List > nebula > drivers

Classes

Type	Name
struct	ConnectionConfiguration Network endpoint settings used by the sample driver.
struct	PacketDecodeResult Result of decoding a single packet.
struct	PacketMetadata Metadata extracted from a decoded packet.
struct	PerformanceCounters Performance metrics for packet decoding.
struct	SampleCalibrationData Calibration data for the Sample LiDAR (required for some sensors)
class	SampleDecoder Decoder that accumulates incoming raw packets and marks scan boundaries.
class	SampleHwInterface Receives raw sensor packets and forwards them to a registered callback.
struct	SampleSensorConfiguration Sensor-specific configuration for the Sample LiDAR.

Public Types

Type	Name
enum uint8_t	DecodeError Error codes returned during packet decoding.

Public Functions

Type	Name
	NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE (ConnectionConfiguration, host_ip, sensor_ip, data_port)
void	from_json (const nlohmann::json & j, SampleSensorConfiguration & config) Parse SampleSensorConfiguration from JSON.
const char *	to_cstr (DecodeError error) Convert DecodeError to a stable string literal for logging.
void	to_json (nlohmann::json & j, const SampleSensorConfiguration & config) Serialize SampleSensorConfiguration to JSON.

Public Types Documentation

enum DecodeError

Error codes returned during packet decoding.

enum nebula::drivers::DecodeError {
    PACKET_FORMAT_INVALID,
    CALLBACK_NOT_SET,
    EMPTY_PACKET
};

Public Functions Documentation

function NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE

nebula::drivers::NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE (
    ConnectionConfiguration,
    host_ip,
    sensor_ip,
    data_port
)

function from_json

Parse SampleSensorConfiguration from JSON.

inline void nebula::drivers::from_json (
    const nlohmann::json & j,
    SampleSensorConfiguration & config
)

Exception:

nlohmann::json::exception if required fields are missing or have incompatible types.

function to_cstr

Convert DecodeError to a stable string literal for logging.

const char * nebula::drivers::to_cstr (
    DecodeError error
)

function to_json

Serialize SampleSensorConfiguration to JSON.

inline void nebula::drivers::to_json (
    nlohmann::json & j,
    const SampleSensorConfiguration & config
)

The JSON schema contains: * connection (ConnectionConfiguration) * fov (FieldOfView)

The documentation for this class was generated from the following file src/nebula_sample/nebula_sample_common/include/nebula_sample_common/sample_calibration_data.hpp