VehicleTickInput Struct

Single wheel encoder tick input, representing vehicle body speed (MessageType::VEHICLE_TICK_INPUT, version 1.0). More...

Declaration

struct point_one::fusion_engine::messages::VehicleTickInput { ... }

Included Headers

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

Base struct

struct	MessagePayload
	The base class for all message payloads. More...

Public Member Attributes Index

MeasurementDetails	details
	Measurement timestamp and additional information, if available. More...
GearType	gear = GearType::UNKNOWN
	The transmission gear currently in use, or direction of motion, if available. More...
uint32_t	tick_count = 0
	The current encoder tick count. More...

Public Static Attributes Index

static constexpr MessageType	MESSAGE_TYPE = MessageType::VEHICLE_TICK_INPUT
static constexpr uint8_t	MESSAGE_VERSION = 0

Description

Single wheel encoder tick input, representing vehicle body speed (MessageType::VEHICLE_TICK_INPUT, version 1.0).

This message is an input to the device, used to convey a single wheel encoder tick count representing the along-track speed of the vehicle (forward/backward). The interpretation of the tick count values varies by vehicle.

To use wheel encoder data, you must first configure the device by issuing a SetConfigMessage message containing either a WheelConfig payload describing the vehicle sensor configuration (tick counts signed/unsigned, etc.). Note that you should not use the HardwareTickConfig payload, which is used when configuring the device to capture a wheel tick voltage signal in hardware.

Some platforms may have an additional signal used to indicate direction of motion, have direction or gear information available from a vehicle CAN bus, etc. If direction/gear information is available, it may be provided in the gear field.

See also RawVehicleTickOutput for measurement output.

Definition at line 962 of file measurements.h.

Public Member Attributes

details

MeasurementDetails point_one::fusion_engine::messages::VehicleTickInput::details

Measurement timestamp and additional information, if available.

See MeasurementDetails for details.

Definition at line 970 of file measurements.h.

970 MeasurementDetails details;

gear

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

985 GearType gear = GearType::UNKNOWN;

tick_count

uint32_t point_one::fusion_engine::messages::VehicleTickInput::tick_count = 0

The current encoder tick count.

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

Definition at line 976 of file measurements.h.

976 uint32_t tick_count = 0;

Public Static Attributes

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::VehicleTickInput::MESSAGE_TYPE = MessageType::VEHICLE_TICK_INPUT

constexpr static

Definition at line 963 of file measurements.h.

963 static constexpr MessageType MESSAGE_TYPE = MessageType::VEHICLE_TICK_INPUT;

MESSAGE_VERSION

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

constexpr static

Definition at line 964 of file measurements.h.

964 static constexpr uint8_t MESSAGE_VERSION = 0;

---

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

• measurements.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.