min_integral and max_integral had transposed minimum & maximum (#3329)

This commit is contained in:
FreeBear-nc 2023-11-04 21:33:36 +00:00 committed by GitHub
parent 0ec701c4a0
commit d1f16a09cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -68,9 +68,9 @@ Configuration variables:
Defaults to ``0``. Defaults to ``0``.
- **kd** (*Optional*, float): The factor for the derivative term of the PID controller. - **kd** (*Optional*, float): The factor for the derivative term of the PID controller.
Defaults to ``0``. Defaults to ``0``.
- **min_integral** (*Optional*, float): The maximum value of the integral term multiplied by - **min_integral** (*Optional*, float): The minimum value of the integral term multiplied by
``ki`` to prevent windup. Defaults to ``-1``. ``ki`` to prevent windup. Defaults to ``-1``.
- **max_integral** (*Optional*, float): The minimum value of the integral term multiplied by - **max_integral** (*Optional*, float): The maximum value of the integral term multiplied by
``ki`` to prevent windup. Defaults to ``1``. ``ki`` to prevent windup. Defaults to ``1``.
- **starting_integral_term** (*Optional*, float): Set the initial output, by priming the integral - **starting_integral_term** (*Optional*, float): Set the initial output, by priming the integral
term. This is useful for when your system is rebooted and you don't want to wait term. This is useful for when your system is rebooted and you don't want to wait