Updated docs, renamed SwerveDrive lock function and setBrake function

This commit is contained in:
thenetworkgrinch
2023-02-15 22:18:27 -06:00
parent e4436b5ed2
commit e8f6ca3659
111 changed files with 3086 additions and 384 deletions

View File

@@ -115,7 +115,8 @@ public class SwerveMath
/**
* Calculates the maximum acceleration allowed in a direction without tipping the robot. Reads arm position from
* NetworkTables and is passed the direction in question.
* NetworkTables and is passed the direction in question.<br /><b>Requires modules to be named: <br
* />"frontright.json", "frontleft.json", "backright.json", "backleft.json"</b>
*
* @param angle The direction in which to calculate max acceleration, as a Rotation2d. Note that this
* is robot-relative.
@@ -182,7 +183,8 @@ public class SwerveMath
/**
* Limits a commanded velocity to prevent exceeding the maximum acceleration given by
* {@link SwerveMath#calcMaxAccel(Rotation2d, double, double, Translation3d, SwerveDriveConfiguration)}. Note that
* this takes and returns field-relative velocities.
* this takes and returns field-relative velocities. <br /><b>Requires modules to be named:<br /> "frontright.json",
* "frontleft.json", "backright.json", "backleft.json"</b>
*
* @param commandedVelocity The desired velocity
* @param fieldVelocity The velocity of the robot within a field relative state.