Sensor Measurement Message Definitions

Detailed Description

Measurement data from available sensors.

See also Message Definitions.

Classes

struct  point_one::fusion_engine::messages::DeprecatedVehicleSpeedMeasurement
 (Deprecated) Vehicle body speed measurement (MessageType::DEPRECATED_VEHICLE_SPEED_MEASUREMENT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::DeprecatedWheelSpeedMeasurement
 (Deprecated) Differential wheel speed measurement (MessageType::DEPRECATED_WHEEL_SPEED_MEASUREMENT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::GNSSAttitudeOutput
 Multi-antenna GNSS attitude sensor measurement output with offset corrections applied (MessageType::GNSS_ATTITUDE_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::IMUInput
 IMU sensor measurement input (MessageType::IMU_INPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::IMUOutput
 IMU sensor measurement output with calibration and corrections applied (MessageType::IMU_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::InputDataWrapperMessage
 A block of incoming sensor data whose definition depends on the value of @ ref data_type. More...
 
struct  point_one::fusion_engine::messages::MeasurementDetails
 The time of applicability and additional information for an incoming sensor measurement. More...
 
struct  point_one::fusion_engine::messages::RawGNSSAttitudeOutput
 Raw (uncorrected) GNSS attitude sensor measurement output (MessageType::RAW_GNSS_ATTITUDE_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::RawIMUOutput
 Raw (uncorrected) IMU sensor measurement output (MessageType::RAW_IMU_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::RawVehicleSpeedOutput
 Raw (uncorrected) vehicle body speed measurement output (MessageType::RAW_VEHICLE_SPEED_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::RawVehicleTickOutput
 Raw (uncorrected) single wheel encoder tick output (MessageType::RAW_VEHICLE_TICK_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::RawWheelSpeedOutput
 Raw (uncorrected) dfferential wheel speed measurement output (MessageType::RAW_WHEEL_SPEED_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::RawWheelTickOutput
 Raw (uncorrected) dfferential wheel encoder tick output (MessageType::RAW_WHEEL_TICK_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::VehicleSpeedInput
 Vehicle body speed measurement input (MessageType::VEHICLE_SPEED_INPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::VehicleSpeedOutput
 Vehicle body speed measurement output with calibration and corrections applied (MessageType::VEHICLE_SPEED_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::VehicleTickInput
 Single wheel encoder tick input, representing vehicle body speed (MessageType::VEHICLE_TICK_INPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::WheelSpeedInput
 Differential wheel speed measurement input (MessageType::WHEEL_SPEED_INPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::WheelSpeedOutput
 Differential wheel speed measurement output with calibration and corrections applied (MessageType::WHEEL_SPEED_OUTPUT, version 1.0). More...
 
struct  point_one::fusion_engine::messages::WheelTickInput
 Differential wheel encoder tick input (MessageType::WHEEL_TICK_INPUT, version 1.0). More...
 

Enumerations

enum  point_one::fusion_engine::messages::GearType : uint8_t {
  point_one::fusion_engine::messages::GearType::UNKNOWN = 0, point_one::fusion_engine::messages::GearType::FORWARD = 1, point_one::fusion_engine::messages::GearType::REVERSE = 2, point_one::fusion_engine::messages::GearType::PARK = 3,
  point_one::fusion_engine::messages::GearType::NEUTRAL = 4
}
 The current transmission gear used by the vehicle. More...
 
enum  point_one::fusion_engine::messages::SensorDataSource : uint8_t {
  point_one::fusion_engine::messages::SensorDataSource::UNKNOWN = 0, point_one::fusion_engine::messages::SensorDataSource::INTERNAL = 1, point_one::fusion_engine::messages::SensorDataSource::HARDWARE_IO = 2, point_one::fusion_engine::messages::SensorDataSource::CAN = 3,
  point_one::fusion_engine::messages::SensorDataSource::SERIAL = 4, point_one::fusion_engine::messages::SensorDataSource::NETWORK = 5
}
 The source of received sensor measurements, if known. More...
 
enum  point_one::fusion_engine::messages::SystemTimeSource : uint8_t {
  point_one::fusion_engine::messages::SystemTimeSource::INVALID = 0, point_one::fusion_engine::messages::SystemTimeSource::P1_TIME = 1, point_one::fusion_engine::messages::SystemTimeSource::TIMESTAMPED_ON_RECEPTION = 2, point_one::fusion_engine::messages::SystemTimeSource::SENDER_SYSTEM_TIME = 3,
  point_one::fusion_engine::messages::SystemTimeSource::GPS_TIME = 4
}
 The source of a point_one::fusion_engine::messages::Timestamp used to represent the time of applicability of an incoming sensor measurement. More...
 

Functions

p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, DeviceType val)
 DeviceType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, GearType val)
 GearType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, SensorDataSource val)
 SensorDataSource stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, SystemTimeSource val)
 SystemTimeSource stream operator. More...
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (GearType val)
 Get a human-friendly string name for the specified GearType. More...
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SensorDataSource val)
 Get a human-friendly string name for the specified SensorDataSource. More...
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SystemTimeSource val)
 Get a human-friendly string name for the specified SystemTimeSource. More...
 

Enumeration Type Documentation

◆ GearType

The current transmission gear used by the vehicle.

Enumerator
UNKNOWN 

The transmission gear is not known, or does not map to a supported GearType.

FORWARD 

The vehicle is in a forward gear.

REVERSE 

The vehicle is in reverse.

PARK 

The vehicle is parked.

NEUTRAL 

The vehicle is in neutral.

Definition at line 367 of file measurements.h.

◆ SensorDataSource

The source of received sensor measurements, if known.

Enumerator
UNKNOWN 

Data source not known.

INTERNAL 

Sensor data captured internal to the device (embedded IMU, GNSS receiver, etc.).

HARDWARE_IO 

Sensor data generated via hardware voltage signal (wheel tick, external event, etc.).

CAN 

Sensor data captured from a vehicle CAN bus.

SERIAL 

Sensor data provided over a serial connection.

NETWORK 

Sensor data provided over a network connection.

Definition at line 33 of file measurements.h.

◆ SystemTimeSource

The source of a point_one::fusion_engine::messages::Timestamp used to represent the time of applicability of an incoming sensor measurement.

Enumerator
INVALID 

Timestamp not valid.

P1_TIME 

Message timestamped in P1 time.

TIMESTAMPED_ON_RECEPTION 

Message timestamped in system time, generated when received by the device.

SENDER_SYSTEM_TIME 

Message timestamp was generated from a monotonic clock of an external system.

GPS_TIME 

Message timestamped in GPS time, referenced to 1980/1/6.

Definition at line 97 of file measurements.h.

Function Documentation

◆ operator<<() [1/4]

p1_ostream& point_one::fusion_engine::messages::operator<< ( p1_ostream stream,
DeviceType  val 
)
inline

DeviceType stream operator.

Definition at line 142 of file device.h.

◆ operator<<() [2/4]

p1_ostream& point_one::fusion_engine::messages::operator<< ( p1_ostream stream,
GearType  val 
)
inline

GearType stream operator.

Definition at line 408 of file measurements.h.

◆ operator<<() [3/4]

p1_ostream& point_one::fusion_engine::messages::operator<< ( p1_ostream stream,
SensorDataSource  val 
)
inline

SensorDataSource stream operator.

Definition at line 86 of file measurements.h.

◆ operator<<() [4/4]

p1_ostream& point_one::fusion_engine::messages::operator<< ( p1_ostream stream,
SystemTimeSource  val 
)
inline

SystemTimeSource stream operator.

Definition at line 147 of file measurements.h.

◆ to_string() [1/3]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( GearType  val)

Get a human-friendly string name for the specified GearType.

Parameters
valThe enum to get the string name for.
Returns
The corresponding string name.

Definition at line 387 of file measurements.h.

◆ to_string() [2/3]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( SensorDataSource  val)

Get a human-friendly string name for the specified SensorDataSource.

Parameters
valThe enum to get the string name for.
Returns
The corresponding string name.

Definition at line 63 of file measurements.h.

◆ to_string() [3/3]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( SystemTimeSource  val)

Get a human-friendly string name for the specified SystemTimeSource.

Parameters
valThe enum to get the string name for.
Returns
The corresponding string name.

Definition at line 126 of file measurements.h.