point_one::fusion_engine::messages::RawWheelTickOutput Struct Reference

Detailed Description

Raw (uncorrected) dfferential wheel encoder tick output (MessageType::RAW_WHEEL_TICK_OUTPUT, version 1.0).

This message is an output from the device that contains wheel encoder tick counts for each individual wheel on the vehicle. Wheel ticks may be captured in hardware from an external voltage pulse, conveyed via software using a WheelTickInput message, or decoded from a vehicle CAN bus. The number and type of wheels expected, and the interpretation of the tick count values, varies by vehicle.

These measurements come directly from the sensor, and do not have any corrections or calibration applied.

See also WheelTickInput.

Definition at line 890 of file measurements.h.

Inheritance diagram for point_one::fusion_engine::messages::RawWheelTickOutput:
point_one::fusion_engine::messages::MessagePayload

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

Public Attributes

MeasurementDetails details
 Measurement timestamp and additional information, if available. More...
 
uint32_t front_left_wheel_ticks = 0
 The front left wheel ticks. More...
 
uint32_t front_right_wheel_ticks = 0
 The front right wheel ticks. More...
 
GearType gear = GearType::UNKNOWN
 The transmission gear currently in use, or direction of motion, if available. More...
 
uint32_t rear_left_wheel_ticks = 0
 The rear left wheel ticks. More...
 
uint32_t rear_right_wheel_ticks = 0
 The rear right wheel ticks. More...
 

Static Public Attributes

static constexpr MessageType MESSAGE_TYPE
 
static constexpr uint8_t MESSAGE_VERSION = 0
 

Member Data Documentation

◆ details

MeasurementDetails point_one::fusion_engine::messages::RawWheelTickOutput::details

Measurement timestamp and additional information, if available.

See MeasurementDetails for details.

Definition at line 899 of file measurements.h.

◆ front_left_wheel_ticks

uint32_t point_one::fusion_engine::messages::RawWheelTickOutput::front_left_wheel_ticks = 0

The front left wheel ticks.

The interpretation of these ticks is defined outside of this message.

Definition at line 905 of file measurements.h.

◆ front_right_wheel_ticks

uint32_t point_one::fusion_engine::messages::RawWheelTickOutput::front_right_wheel_ticks = 0

The front right wheel ticks.

The interpretation of these ticks is defined outside of this message.

Definition at line 911 of file measurements.h.

◆ gear

GearType point_one::fusion_engine::messages::RawWheelTickOutput::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 932 of file measurements.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::RawWheelTickOutput::MESSAGE_TYPE
staticconstexpr
Initial value:

Definition at line 891 of file measurements.h.

◆ MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::RawWheelTickOutput::MESSAGE_VERSION = 0
staticconstexpr

Definition at line 893 of file measurements.h.

◆ rear_left_wheel_ticks

uint32_t point_one::fusion_engine::messages::RawWheelTickOutput::rear_left_wheel_ticks = 0

The rear left wheel ticks.

The interpretation of these ticks is defined outside of this message.

Definition at line 917 of file measurements.h.

◆ rear_right_wheel_ticks

uint32_t point_one::fusion_engine::messages::RawWheelTickOutput::rear_right_wheel_ticks = 0

The rear right wheel ticks.

The interpretation of these ticks is defined outside of this message.

Definition at line 923 of file measurements.h.


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