diff --git a/Parameters.md b/Parameters.md index 2bda7cc..a20254a 100644 --- a/Parameters.md +++ b/Parameters.md @@ -1,18 +1,18 @@ Parameters are used in [config.h](https://github.com/EFeru/hoverboard-firmware-hack-FOC/blob/master/Inc/config.h) to configure the behavior of the firmware, by enabling/disabling features, or adjusting value. -### Battery Management +### :battery: Battery Management For parameters related to Battery Management, please visit following [wiki section](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Battery). ### Variant specific parameters Variant specific parameters are covered in the wiki section of for each variant. -### Input Calibration +### :control_knobs: Input Calibration For Parameters related to Input Calibration, please visit following [wiki section](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Input-Calibration). ## Further Input processing After the inputs have been mapped to the MIN, MID and MAX value that have been calibrated, following parameters can help adjust the behavior of the firmware. -### Rate limiting +### :chart_with_upwards_trend: Rate limiting DEFAULT_RATE parameter is used to limit the rate of change of the inputs in the main loop between 2 loop iterations.
This helps smooth out the final ouput to the motor control model.
The default value is 480 in fixed-point, which corresponds to 30 value in single precision.
@@ -36,7 +36,7 @@ A rate of 32767 in fixed-point means the value can increase/decrease by an incre Please don't change this parameter if you don't know what you are doing, this can lead to issues.
⚠ Don't set the RATE parameter higher than 32767, this corresponds to a Negative Rate in single precision value. -### Filtering +### :chart_with_upwards_trend: Filtering DEFAULT_FILTER parameter is used to smooth out (low-pass filter) the output value to the motor control.
The default value is 6553 in fixed-point, which corresponds to a filter of 0.1 in single precision.
This means if the input goes from 0 to 300, the output value will be 90% of the previous value + 10% of the new value