Skip to content

Commit

Permalink
Clarified wheel tick output interval parameter description.
Browse files Browse the repository at this point in the history
  • Loading branch information
adamshapiro0 committed Oct 19, 2023
1 parent 0debc82 commit 2cf3354
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
6 changes: 5 additions & 1 deletion python/fusion_engine_client/messages/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,11 @@ class WheelConfig(NamedTuple):
steering_type: SteeringType = SteeringType.UNKNOWN
## The nominal rate at which wheel speed measurements will be provided (in seconds).
wheel_update_interval_sec: float = math.nan
## The nominal rate at which wheel tick measurements will be provided (in seconds).
##
# Override the rate at which wheel tick measurements will be used by the navigation engine (in seconds).
#
# @warning
# We do _not_ recommend setting this value for most system configurations.
wheel_tick_output_interval_sec: float = math.nan
## Ratio between angle of the steering wheel and the angle of the wheels on the ground.
steering_ratio: float = math.nan
Expand Down
15 changes: 11 additions & 4 deletions src/point_one/fusion_engine/messages/configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -1061,14 +1061,21 @@ struct P1_ALIGNAS(4) WheelConfig {
uint8_t reserved1[1] = {0};

/**
* The nominal rate at which wheel speed measurements will be provided (in
* seconds).
* The rate at which wheel speed/tick measurements will be sent to the device
* (in seconds).
*/
float wheel_update_interval_sec = NAN;

/**
* The nominal rate at which wheel tick measurements will be provided (in
* seconds).
* Override the rate at which wheel tick measurements will be used by the
* navigation engine (in seconds).
*
* If this parameter is `NAN`, the best rate will be selected automatically by
* the device based on the input rate (@ref wheel_update_interval_sec) and the
* wheel tick quantization (@ref wheel_ticks_to_m).
*
* @warning
* We do _not_ recommend setting this value for most system configurations.
*/
float wheel_tick_output_interval_sec = NAN;

Expand Down

0 comments on commit 2cf3354

Please sign in to comment.