[wpimath] Document drift from desaturating discretized chassis speeds (NFC) (#7741)

This commit is contained in:
Joseph Eng
2025-02-03 10:46:18 -08:00
committed by GitHub
parent 18321e5551
commit 296986397b
4 changed files with 48 additions and 5 deletions

View File

@@ -335,6 +335,11 @@ class SwerveDriveKinematics
* the absolute threshold, while maintaining the ratio of speeds between
* modules.
*
* Scaling down the module speeds rotates the direction of net motion in the
* opposite direction of rotational velocity, which makes discretizing the
* chassis speeds inaccurate because the discretization did not account for
* this translational skew.
*
* @param moduleStates Reference to array of module states. The array will be
* mutated with the normalized speeds!
* @param attainableMaxSpeed The absolute max speed that a module can reach.
@@ -370,6 +375,11 @@ class SwerveDriveKinematics
* the absolute threshold, while maintaining the ratio of speeds between
* modules.
*
* Scaling down the module speeds rotates the direction of net motion in the
* opposite direction of rotational velocity, which makes discretizing the
* chassis speeds inaccurate because the discretization did not account for
* this translational skew.
*
* @param moduleStates Reference to array of module states. The array will be
* mutated with the normalized speeds!
* @param desiredChassisSpeed The desired speed of the robot