Updated Parameters (markdown)

Candas1
2022-04-21 09:19:57 +02:00
parent 6b7e1779f5
commit 01143ecff4

@@ -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. 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). 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
Variant specific parameters are covered in the wiki section of for each variant. 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). 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 ## 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. 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.<br> DEFAULT_RATE parameter is used to limit the rate of change of the inputs in the main loop between 2 loop iterations.<br>
This helps smooth out the final ouput to the motor control model.<br> This helps smooth out the final ouput to the motor control model.<br>
The default value is 480 in fixed-point, which corresponds to 30 value in single precision.<br> The default value is 480 in fixed-point, which corresponds to 30 value in single precision.<br>
@@ -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.<br> Please don't change this parameter if you don't know what you are doing, this can lead to issues.<br>
⚠ Don't set the RATE parameter higher than 32767, this corresponds to a Negative Rate in single precision value. ⚠ 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.<br> DEFAULT_FILTER parameter is used to smooth out (low-pass filter) the output value to the motor control.<br>
The default value is 6553 in fixed-point, which corresponds to a filter of 0.1 in single precision.<br> The default value is 6553 in fixed-point, which corresponds to a filter of 0.1 in single precision.<br>
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 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