Speedometer

This module provides a set of functionalities for managing the Speedometer system, including initialization, speed factor conversion, speed ramping, and hysteresis filtering to ensure smooth transitions and accurate display of speed data.

Configuration Parameters

All API functions have the first argument as the module ID.

Configuration
Name	Description	Range
enable	Enables Speedometer functionality.	0 (disabled) or 1 (enabled)
scaling_multiplier	Multiplier for scaling the raw speed data to a displayable value.	Positive integer values.
scaling_divisor	Divisor for scaling the raw speed data.	Positive integer values.
ramp_value	Value for ramping speed adjustments.	0 to 255
max_speed	Maximum speed limit for the speedometer.	0 to 255 (unit: defined by unit)
speedo_hysteresis	Speedometer Hysteresis value.	0 to 255

APIs

The Speedometer module provides the following APIs to initialize, process, and update the speedometer data:

API Functions
Function	Description
rs_am_speedometer_init	Initializes the speedometer system with default configuration values.
rs_am_speedometer_process	Processes the speedometer system by updating the speed data based on current conditions.

Error Codes

Each API for the filter moving average module returns success or failure codes. For detailed information on the error codes, please refer to the following section:

Speedometer Module Header Details

The header file for speedometer modules, rs_am_speedometer.h, defines the required structures and APIs for initialization and processing.

Warning

doxygenfile: Cannot find file “rs_am_speedometer.h