point_one::fusion_engine::messages::HardwareTickConfig Struct Reference

Hardware wheel encoder configuration settings. More...

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

Public Attributes
TickDirection	tick_direction = TickDirection::OFF
	When direction is TickDirection::OFF, the incoming ticks will be treated as unsigned, meaning the tick count will continue to increase in either direction of travel. More...
TickMode	tick_mode = TickMode::OFF
	If enabled – tick mode is not TickMode::OFF – the device will accumulate ticks received on the I/O pin, and use them as an indication of vehicle speed. More...
float	wheel_ticks_to_m = NAN
	The scale factor to convert from wheel encoder ticks to distance (in meters/tick). More...

Detailed Description

Hardware wheel encoder configuration settings.

See VehicleTickMeasurement.

Definition at line 931 of file configuration.h.

Member Data Documentation

tick_direction

TickDirection point_one::fusion_engine::messages::HardwareTickConfig::tick_direction = TickDirection::OFF

When direction is TickDirection::OFF, the incoming ticks will be treated as unsigned, meaning the tick count will continue to increase in either direction of travel.

If direction is not TickDirection::OFF, a second direction I/O pin will be used to indicate the direction of travel and the accumulated tick count will increase/decrease accordingly.

Definition at line 952 of file configuration.h.

tick_mode

TickMode point_one::fusion_engine::messages::HardwareTickConfig::tick_mode = TickMode::OFF

If enabled – tick mode is not TickMode::OFF – the device will accumulate ticks received on the I/O pin, and use them as an indication of vehicle speed.

If enabled, you must also specify wheel_ticks_to_m to indicate the mapping of wheel tick encoder angle to tire circumference. All other wheel tick-related parameters such as tick capture rate, rollover value, etc. will be set internally.

Warning

Do not enable this feature if a wheel tick voltage signal is not present.

Definition at line 943 of file configuration.h.

wheel_ticks_to_m

float point_one::fusion_engine::messages::HardwareTickConfig::wheel_ticks_to_m = NAN

The scale factor to convert from wheel encoder ticks to distance (in meters/tick).

Used for WheelSensorType::TICKS and WheelSensorType::TICK_RATE.

Definition at line 961 of file configuration.h.

---

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

• src/point_one/fusion_engine/messages/configuration.h