swerve drive docstrings

README.md

@@ -2,7 +2,7 @@
 
 Base robot code for all 4829 robots.
 
-Includes code for: 
+Includes code for:
 - Simulation
 - Swerve drive
 - Threaded vision

src/main/java/frc/robot/BuildConstants.java

@@ -1,17 +1,19 @@
 package frc.robot;
 
-/** Automatically generated file containing build version information. */
+/**
+ * Automatically generated file containing build version information.
+ */
 public final class BuildConstants {
   public static final String MAVEN_GROUP = "";
   public static final String MAVEN_NAME = "4829-BaseRobotCode-2025-1";
   public static final String VERSION = "unspecified";
-  public static final int GIT_REVISION = 22;
-  public static final String GIT_SHA = "ee746c8ba2b3fd21fde3a8e41cdd2f213deee1be";
-  public static final String GIT_DATE = "2024-10-27 14:01:12 EDT";
-  public static final String GIT_BRANCH = "k";
-  public static final String BUILD_DATE = "2024-10-27 14:10:44 EDT";
-  public static final long BUILD_UNIX_TIME = 1730052644497L;
-  public static final int DIRTY = 1;
+  public static final int GIT_REVISION = 25;
+  public static final String GIT_SHA = "3b5012c7524895e7c511a707a351c6a1f9225018";
+  public static final String GIT_DATE = "2024-10-28 14:52:32 EDT";
+  public static final String GIT_BRANCH = "docs";
+  public static final String BUILD_DATE = "2024-10-28 14:53:10 EDT";
+  public static final long BUILD_UNIX_TIME = 1730141590401L;
+  public static final int DIRTY = 0;
 
-  private BuildConstants() {}
+  private BuildConstants(){}
 }

src/main/java/frc/robot/extras/simulation/OdometryTimestampsSim.java

@@ -5,7 +5,7 @@
 import frc.robot.extras.simulation.field.SimulatedField;
 
 public class OdometryTimestampsSim {
-  public static double[] getTimeStamps() {
+  public static double[] getTimestamps() {
     final double[] odometryTimestamps = new double[5];
     for (int i = 0; i < 5; i++)
       odometryTimestamps[i] =

src/main/java/frc/robot/extras/simulation/field/SimulatedField.java

@@ -7,7 +7,7 @@
 import frc.robot.extras.simulation.gamePiece.CrescendoNoteSimulation;
 import frc.robot.extras.simulation.gamePiece.GamePieceSimulation;
 import frc.robot.extras.simulation.mechanismSim.IntakeSimulation;
-import frc.robot.extras.simulation.mechanismSim.swervePhysicsSim.AbstractDriveTrainSimulation;
+import frc.robot.extras.simulation.mechanismSim.swerve.AbstractDriveTrainSimulation;
 import frc.robot.extras.util.GeomUtil;
 import java.util.*;
 import org.dyn4j.dynamics.Body;

src/main/java/frc/robot/extras/simulation/mechanismSim/IntakeSimulation.java

@@ -3,7 +3,7 @@
 import edu.wpi.first.math.geometry.Translation2d;
 import frc.robot.extras.simulation.field.SimulatedField;
 import frc.robot.extras.simulation.gamePiece.GamePieceSimulation;
-import frc.robot.extras.simulation.mechanismSim.swervePhysicsSim.AbstractDriveTrainSimulation;
+import frc.robot.extras.simulation.mechanismSim.swerve.AbstractDriveTrainSimulation;
 import frc.robot.extras.util.GeomUtil;
 import java.util.ArrayDeque;
 import java.util.Queue;

src/main/java/frc/robot/extras/simulation/mechanismSim/swervePhysicsSim/AbstractDriveTrainSimulation.java → src/main/java/frc/robot/extras/simulation/mechanismSim/swerve/AbstractDriveTrainSimulation.java

@@ -1,4 +1,4 @@
-package frc.robot.extras.simulation.mechanismSim.swervePhysicsSim;
+package frc.robot.extras.simulation.mechanismSim.swerve;
 
 import edu.wpi.first.math.geometry.Pose2d;
 import edu.wpi.first.math.kinematics.ChassisSpeeds;

src/main/java/frc/robot/extras/simulation/mechanismSim/swervePhysicsSim/BrushlessMotorSim.java → src/main/java/frc/robot/extras/simulation/mechanismSim/swerve/BrushlessMotorSim.java

@@ -22,7 +22,7 @@
 // Original source:
 // https://github.com/Shenzhen-Robotics-Alliance/maple-sim/blob/main/src/main/java/org/ironmaple/simulation/drivesims/BrushlessMotorSim.java
 
-package frc.robot.extras.simulation.mechanismSim.swervePhysicsSim;
+package frc.robot.extras.simulation.mechanismSim.swerve;
 
 import edu.wpi.first.math.MathUtil;
 import edu.wpi.first.math.system.plant.DCMotor;

src/main/java/frc/robot/extras/simulation/mechanismSim/swervePhysicsSim/GyroSimulation.java → src/main/java/frc/robot/extras/simulation/mechanismSim/swerve/GyroSimulation.java

@@ -1,4 +1,4 @@
-package frc.robot.extras.simulation.mechanismSim.swervePhysicsSim;
+package frc.robot.extras.simulation.mechanismSim.swerve;
 
 import static frc.robot.extras.simulation.field.SimulatedField.*;
 

src/main/java/frc/robot/extras/simulation/mechanismSim/swervePhysicsSim/SwerveDriveSimulation.java → src/main/java/frc/robot/extras/simulation/mechanismSim/swerve/SwerveDriveSimulation.java

@@ -1,4 +1,4 @@
-package frc.robot.extras.simulation.mechanismSim.swervePhysicsSim;
+package frc.robot.extras.simulation.mechanismSim.swerve;
 
 import edu.wpi.first.math.geometry.Pose2d;
 import edu.wpi.first.math.geometry.Rotation2d;