Vehicle body speed measurement (MessageType::VEHICLE_SPEED_MEASUREMENT, version 1.0). More...

#include <point_one/fusion_engine/messages/measurements.h>

Inheritance diagram for point_one::fusion_engine::messages::VehicleSpeedMeasurement:

Public Attributes
GearType	gear = GearType::UNKNOWN
	The transmission gear currently in use, or direction of motion, if available. More...

bool	is_signed = true
	`true` if the wheel speeds are signed (positive forward, negative reverse), or `false` if the values are unsigned (positive in both directions). More...

MeasurementTimestamps	timestamps
	Measurement timestamps, if available. More...

float	vehicle_speed_mps = NAN
	The current vehicle speed estimate (in m/s). More...

Static Public Attributes
static constexpr MessageType	MESSAGE_TYPE

static constexpr uint8_t	MESSAGE_VERSION = 0

Detailed Description

Vehicle body speed measurement (MessageType::VEHICLE_SPEED_MEASUREMENT, version 1.0).

This message may be used to convey the along-track speed of the vehicle (forward/backward). To use vehicle speed data, you must first configure the device by issuing a SetConfigMessage message containing a WheelConfig payload describing the vehicle sensor configuration.

Some platforms may support an additional, optional voltage signal used to indicate direction of motion. Alternatively, when receiving CAN data from a vehicle, direction may be conveyed explicitly in a CAN message, or may be indicated based on the current transmission gear setting.

Definition at line 307 of file measurements.h.

Member Data Documentation

◆ gear

GearType point_one::fusion_engine::messages::VehicleSpeedMeasurement::gear = GearType::UNKNOWN

The transmission gear currently in use, or direction of motion, if available.

Set to GearType::FORWARD or GearType::REVERSE where vehicle direction information is available externally.

Definition at line 325 of file measurements.h.

◆ is_signed

bool point_one::fusion_engine::messages::VehicleSpeedMeasurement::is_signed = true

true if the wheel speeds are signed (positive forward, negative reverse), or false if the values are unsigned (positive in both directions).

Definition at line 331 of file measurements.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::VehicleSpeedMeasurement::MESSAGE_TYPE

staticconstexpr

Initial value:

=

MessageType::VEHICLE_SPEED_MEASUREMENT

Definition at line 308 of file measurements.h.

◆ MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::VehicleSpeedMeasurement::MESSAGE_VERSION = 0

staticconstexpr

Definition at line 310 of file measurements.h.

◆ timestamps

MeasurementTimestamps point_one::fusion_engine::messages::VehicleSpeedMeasurement::timestamps

Measurement timestamps, if available.

See Sensor Measurement Message Definitions.

Definition at line 313 of file measurements.h.

◆ vehicle_speed_mps

float point_one::fusion_engine::messages::VehicleSpeedMeasurement::vehicle_speed_mps = NAN

The current vehicle speed estimate (in m/s).

Definition at line 316 of file measurements.h.

The documentation for this struct was generated from the following file:

src/point_one/fusion_engine/messages/measurements.h

Public Attributes

Static Public Attributes