Skip to main content

HardwareTickConfig Struct

Hardware wheel tick encoder configuration settings. More...

Declaration​

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

Included Headers​

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

Public Member Attributes Index​

TickDirectiontick_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...

TickModetick_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...

floatwheel_ticks_to_m = NAN

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

Description​

Hardware wheel tick encoder configuration settings.

warning

The HardwareTickConfig payload is intended for use on vehicles with a physical voltage signal, generated by a wheel encoder, that produces a series of voltage pulses (encoder ticks) as the vehicle’s wheel rotates. These ticks will be captured by the device on an input pin and used to indicate vehicle speed. For vehicles using software wheel speed/tick information, including data send using FusionEngine messages or a vehicle CAN bus, use WheelConfig instead.

info

In addition to the wheel tick signal, an optional voltage signal may be provided to indicate vehicle direction. If this signal is not connected, the tick_direction setting MUST be set to OFF otherwise there will be substantial errors in dead reckoning.

See also VehicleTickInput.

Definition at line 1207 of file configuration.h.

Public Member Attributes​

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 1228 of file configuration.h.

1228 TickDirection tick_direction = TickDirection::OFF;

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 1219 of file configuration.h.

1219 TickMode tick_mode = TickMode::OFF;

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.

Definition at line 1236 of file configuration.h.

1236 float wheel_ticks_to_m = NAN;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.