From ecef13c190fdf05a2b4d9cbb573c9c08ee8d64bd Mon Sep 17 00:00:00 2001 From: thenetworkgrinch Date: Sat, 8 Apr 2023 13:35:46 -0500 Subject: [PATCH] Updated docs --- docs/allclasses-index.html | 2 +- docs/allpackages-index.html | 2 +- docs/constant-values.html | 2 +- docs/help-doc.html | 2 +- docs/index-files/index-1.html | 2 +- docs/index-files/index-10.html | 2 +- docs/index-files/index-11.html | 2 +- docs/index-files/index-12.html | 2 +- docs/index-files/index-13.html | 2 +- docs/index-files/index-14.html | 2 +- docs/index-files/index-15.html | 2 +- docs/index-files/index-16.html | 2 +- docs/index-files/index-17.html | 2 +- docs/index-files/index-18.html | 2 +- docs/index-files/index-19.html | 2 +- docs/index-files/index-2.html | 2 +- docs/index-files/index-20.html | 2 +- docs/index-files/index-21.html | 2 +- docs/index-files/index-22.html | 2 +- docs/index-files/index-23.html | 2 +- docs/index-files/index-24.html | 2 +- docs/index-files/index-25.html | 2 +- docs/index-files/index-26.html | 2 +- docs/index-files/index-3.html | 2 +- docs/index-files/index-4.html | 2 +- docs/index-files/index-5.html | 2 +- docs/index-files/index-6.html | 2 +- docs/index-files/index-7.html | 2 +- docs/index-files/index-8.html | 2 +- docs/index-files/index-9.html | 2 +- docs/index.html | 2 +- docs/overview-summary.html | 2 +- docs/overview-tree.html | 2 +- docs/swervelib/SwerveController.html | 2 +- docs/swervelib/SwerveDrive.html | 2 +- docs/swervelib/SwerveModule.html | 2 +- docs/swervelib/encoders/AnalogAbsoluteEncoderSwerve.html | 2 +- docs/swervelib/encoders/CANCoderSwerve.html | 2 +- docs/swervelib/encoders/SparkMaxEncoderSwerve.html | 2 +- docs/swervelib/encoders/SwerveAbsoluteEncoder.html | 2 +- docs/swervelib/encoders/package-summary.html | 2 +- docs/swervelib/encoders/package-tree.html | 2 +- docs/swervelib/imu/ADIS16448Swerve.html | 2 +- docs/swervelib/imu/ADIS16470Swerve.html | 2 +- docs/swervelib/imu/ADXRS450Swerve.html | 2 +- docs/swervelib/imu/AnalogGyroSwerve.html | 2 +- docs/swervelib/imu/NavXSwerve.html | 2 +- docs/swervelib/imu/Pigeon2Swerve.html | 2 +- docs/swervelib/imu/PigeonSwerve.html | 2 +- docs/swervelib/imu/SwerveIMU.html | 2 +- docs/swervelib/imu/package-summary.html | 2 +- docs/swervelib/imu/package-tree.html | 2 +- docs/swervelib/math/Matter.html | 2 +- docs/swervelib/math/SwerveDriveOdometry2.html | 2 +- docs/swervelib/math/SwerveKinematics2.html | 2 +- docs/swervelib/math/SwerveMath.html | 4 +++- docs/swervelib/math/SwerveModuleState2.html | 2 +- .../math/SwervePoseEstimator2.InterpolationRecord.html | 2 +- docs/swervelib/math/SwervePoseEstimator2.html | 2 +- docs/swervelib/math/package-summary.html | 2 +- docs/swervelib/math/package-tree.html | 2 +- docs/swervelib/motors/SparkMaxBrushedMotorSwerve.html | 2 +- docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html | 2 +- docs/swervelib/motors/SparkMaxSwerve.html | 2 +- docs/swervelib/motors/SwerveMotor.html | 2 +- docs/swervelib/motors/TalonFXSwerve.html | 2 +- docs/swervelib/motors/TalonSRXSwerve.html | 2 +- docs/swervelib/motors/package-summary.html | 2 +- docs/swervelib/motors/package-tree.html | 2 +- docs/swervelib/package-summary.html | 2 +- docs/swervelib/package-tree.html | 2 +- docs/swervelib/parser/PIDFConfig.html | 2 +- docs/swervelib/parser/SwerveControllerConfiguration.html | 2 +- docs/swervelib/parser/SwerveDriveConfiguration.html | 2 +- docs/swervelib/parser/SwerveModuleConfiguration.html | 3 ++- .../swervelib/parser/SwerveModulePhysicalCharacteristics.html | 2 +- docs/swervelib/parser/SwerveParser.html | 2 +- docs/swervelib/parser/deserializer/PIDFRange.html | 2 +- docs/swervelib/parser/deserializer/package-summary.html | 2 +- docs/swervelib/parser/deserializer/package-tree.html | 2 +- docs/swervelib/parser/json/ControllerPropertiesJson.html | 2 +- docs/swervelib/parser/json/DeviceJson.html | 2 +- docs/swervelib/parser/json/ModuleJson.html | 2 +- docs/swervelib/parser/json/MotorConfigDouble.html | 2 +- docs/swervelib/parser/json/MotorConfigInt.html | 2 +- docs/swervelib/parser/json/PIDFPropertiesJson.html | 2 +- docs/swervelib/parser/json/PhysicalPropertiesJson.html | 2 +- docs/swervelib/parser/json/SwerveDriveJson.html | 2 +- docs/swervelib/parser/json/modules/BoolMotorJson.html | 2 +- docs/swervelib/parser/json/modules/LocationJson.html | 2 +- docs/swervelib/parser/json/modules/package-summary.html | 2 +- docs/swervelib/parser/json/modules/package-tree.html | 2 +- docs/swervelib/parser/json/package-summary.html | 2 +- docs/swervelib/parser/json/package-tree.html | 2 +- docs/swervelib/parser/package-summary.html | 2 +- docs/swervelib/parser/package-tree.html | 2 +- docs/swervelib/simulation/SwerveIMUSimulation.html | 2 +- docs/swervelib/simulation/SwerveModuleSimulation.html | 2 +- docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html | 2 +- docs/swervelib/simulation/ctre/PhysicsSim.html | 2 +- docs/swervelib/simulation/ctre/TalonFXSimProfile.html | 2 +- docs/swervelib/simulation/ctre/TalonSRXSimProfile.html | 2 +- docs/swervelib/simulation/ctre/VictorSPXSimProfile.html | 2 +- docs/swervelib/simulation/ctre/package-summary.html | 2 +- docs/swervelib/simulation/ctre/package-tree.html | 2 +- docs/swervelib/simulation/package-summary.html | 2 +- docs/swervelib/simulation/package-tree.html | 2 +- .../telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html | 2 +- docs/swervelib/telemetry/SwerveDriveTelemetry.html | 2 +- docs/swervelib/telemetry/package-summary.html | 2 +- docs/swervelib/telemetry/package-tree.html | 2 +- swervelib/math/SwerveMath.java | 1 + swervelib/parser/SwerveModuleConfiguration.java | 1 + 113 files changed, 116 insertions(+), 111 deletions(-) diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html index c9f126a..f59b2d3 100644 --- a/docs/allclasses-index.html +++ b/docs/allclasses-index.html @@ -1,7 +1,7 @@ - + All Classes and Interfaces diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html index 3add5fb..72496d6 100644 --- a/docs/allpackages-index.html +++ b/docs/allpackages-index.html @@ -1,7 +1,7 @@ - + All Packages diff --git a/docs/constant-values.html b/docs/constant-values.html index 7b53422..3ba7f4d 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -1,7 +1,7 @@ - + Constant Field Values diff --git a/docs/help-doc.html b/docs/help-doc.html index fdf09ee..9f389ad 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -1,7 +1,7 @@ - + API Help diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index 3bdcb49..023eef9 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -1,7 +1,7 @@ - + A-Index diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index a595ed9..5bac2e3 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -1,7 +1,7 @@ - + K-Index diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index 1c11082..70c39dc 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -1,7 +1,7 @@ - + L-Index diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index 6df957a..f2cd951 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -1,7 +1,7 @@ - + M-Index diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html index 8f09ba6..ec5efc9 100644 --- a/docs/index-files/index-13.html +++ b/docs/index-files/index-13.html @@ -1,7 +1,7 @@ - + N-Index diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html index 06abc75..67c6e74 100644 --- a/docs/index-files/index-14.html +++ b/docs/index-files/index-14.html @@ -1,7 +1,7 @@ - + O-Index diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html index bbc102d..ab5b8f2 100644 --- a/docs/index-files/index-15.html +++ b/docs/index-files/index-15.html @@ -1,7 +1,7 @@ - + P-Index diff --git a/docs/index-files/index-16.html b/docs/index-files/index-16.html index 61ec97b..8a31f98 100644 --- a/docs/index-files/index-16.html +++ b/docs/index-files/index-16.html @@ -1,7 +1,7 @@ - + Q-Index diff --git a/docs/index-files/index-17.html b/docs/index-files/index-17.html index 762dcf3..ad64310 100644 --- a/docs/index-files/index-17.html +++ b/docs/index-files/index-17.html @@ -1,7 +1,7 @@ - + R-Index diff --git a/docs/index-files/index-18.html b/docs/index-files/index-18.html index 58809a3..177a6f9 100644 --- a/docs/index-files/index-18.html +++ b/docs/index-files/index-18.html @@ -1,7 +1,7 @@ - + S-Index diff --git a/docs/index-files/index-19.html b/docs/index-files/index-19.html index 67aa39d..1066289 100644 --- a/docs/index-files/index-19.html +++ b/docs/index-files/index-19.html @@ -1,7 +1,7 @@ - + T-Index diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index 4644b47..1006c9e 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -1,7 +1,7 @@ - + B-Index diff --git a/docs/index-files/index-20.html b/docs/index-files/index-20.html index b21111e..574ce5e 100644 --- a/docs/index-files/index-20.html +++ b/docs/index-files/index-20.html @@ -1,7 +1,7 @@ - + U-Index diff --git a/docs/index-files/index-21.html b/docs/index-files/index-21.html index f333329..aeeb1e6 100644 --- a/docs/index-files/index-21.html +++ b/docs/index-files/index-21.html @@ -1,7 +1,7 @@ - + V-Index diff --git a/docs/index-files/index-22.html b/docs/index-files/index-22.html index 8502ba0..5b81394 100644 --- a/docs/index-files/index-22.html +++ b/docs/index-files/index-22.html @@ -1,7 +1,7 @@ - + W-Index diff --git a/docs/index-files/index-23.html b/docs/index-files/index-23.html index 05340e1..97a6908 100644 --- a/docs/index-files/index-23.html +++ b/docs/index-files/index-23.html @@ -1,7 +1,7 @@ - + X-Index diff --git a/docs/index-files/index-24.html b/docs/index-files/index-24.html index 71d2372..00a50e0 100644 --- a/docs/index-files/index-24.html +++ b/docs/index-files/index-24.html @@ -1,7 +1,7 @@ - + Y-Index diff --git a/docs/index-files/index-25.html b/docs/index-files/index-25.html index 463f96b..c84e355 100644 --- a/docs/index-files/index-25.html +++ b/docs/index-files/index-25.html @@ -1,7 +1,7 @@ - + Z-Index diff --git a/docs/index-files/index-26.html b/docs/index-files/index-26.html index f9753c8..e3fb3d3 100644 --- a/docs/index-files/index-26.html +++ b/docs/index-files/index-26.html @@ -1,7 +1,7 @@ - + _-Index diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index f26a0f9..6d44fdc 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -1,7 +1,7 @@ - + C-Index diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 4c85495..d031edc 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -1,7 +1,7 @@ - + D-Index diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index aeb6e04..9f15e4e 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -1,7 +1,7 @@ - + E-Index diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index 298a187..fa1fd66 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -1,7 +1,7 @@ - + F-Index diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index d6b0517..e0fddec 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -1,7 +1,7 @@ - + G-Index diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index dcf5e0e..90cf8fe 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -1,7 +1,7 @@ - + H-Index diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index 597b433..3c3c833 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -1,7 +1,7 @@ - + I-Index diff --git a/docs/index.html b/docs/index.html index 6d98352..f14b3fe 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,7 +1,7 @@ - + Overview diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 19e27ac..9f2c591 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -1,7 +1,7 @@ - + Generated Documentation (Untitled) diff --git a/docs/overview-tree.html b/docs/overview-tree.html index bd8c79a..a763e9f 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -1,7 +1,7 @@ - + Class Hierarchy diff --git a/docs/swervelib/SwerveController.html b/docs/swervelib/SwerveController.html index 6dbe89d..b29f9d1 100644 --- a/docs/swervelib/SwerveController.html +++ b/docs/swervelib/SwerveController.html @@ -1,7 +1,7 @@ - + SwerveController diff --git a/docs/swervelib/SwerveDrive.html b/docs/swervelib/SwerveDrive.html index ed540fe..85b549a 100644 --- a/docs/swervelib/SwerveDrive.html +++ b/docs/swervelib/SwerveDrive.html @@ -1,7 +1,7 @@ - + SwerveDrive diff --git a/docs/swervelib/SwerveModule.html b/docs/swervelib/SwerveModule.html index fbe27ca..333b7e3 100644 --- a/docs/swervelib/SwerveModule.html +++ b/docs/swervelib/SwerveModule.html @@ -1,7 +1,7 @@ - + SwerveModule diff --git a/docs/swervelib/encoders/AnalogAbsoluteEncoderSwerve.html b/docs/swervelib/encoders/AnalogAbsoluteEncoderSwerve.html index bc4c205..9f154a8 100644 --- a/docs/swervelib/encoders/AnalogAbsoluteEncoderSwerve.html +++ b/docs/swervelib/encoders/AnalogAbsoluteEncoderSwerve.html @@ -1,7 +1,7 @@ - + AnalogAbsoluteEncoderSwerve diff --git a/docs/swervelib/encoders/CANCoderSwerve.html b/docs/swervelib/encoders/CANCoderSwerve.html index 989f169..40a671d 100644 --- a/docs/swervelib/encoders/CANCoderSwerve.html +++ b/docs/swervelib/encoders/CANCoderSwerve.html @@ -1,7 +1,7 @@ - + CANCoderSwerve diff --git a/docs/swervelib/encoders/SparkMaxEncoderSwerve.html b/docs/swervelib/encoders/SparkMaxEncoderSwerve.html index 49f75a5..b73b5e7 100644 --- a/docs/swervelib/encoders/SparkMaxEncoderSwerve.html +++ b/docs/swervelib/encoders/SparkMaxEncoderSwerve.html @@ -1,7 +1,7 @@ - + SparkMaxEncoderSwerve diff --git a/docs/swervelib/encoders/SwerveAbsoluteEncoder.html b/docs/swervelib/encoders/SwerveAbsoluteEncoder.html index e9c4db4..7260a3c 100644 --- a/docs/swervelib/encoders/SwerveAbsoluteEncoder.html +++ b/docs/swervelib/encoders/SwerveAbsoluteEncoder.html @@ -1,7 +1,7 @@ - + SwerveAbsoluteEncoder diff --git a/docs/swervelib/encoders/package-summary.html b/docs/swervelib/encoders/package-summary.html index 272cb7e..89369d8 100644 --- a/docs/swervelib/encoders/package-summary.html +++ b/docs/swervelib/encoders/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.encoders diff --git a/docs/swervelib/encoders/package-tree.html b/docs/swervelib/encoders/package-tree.html index 378e043..f592ab9 100644 --- a/docs/swervelib/encoders/package-tree.html +++ b/docs/swervelib/encoders/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.encoders Class Hierarchy diff --git a/docs/swervelib/imu/ADIS16448Swerve.html b/docs/swervelib/imu/ADIS16448Swerve.html index 6c470b6..9c651bd 100644 --- a/docs/swervelib/imu/ADIS16448Swerve.html +++ b/docs/swervelib/imu/ADIS16448Swerve.html @@ -1,7 +1,7 @@ - + ADIS16448Swerve diff --git a/docs/swervelib/imu/ADIS16470Swerve.html b/docs/swervelib/imu/ADIS16470Swerve.html index 2d34357..d795a2c 100644 --- a/docs/swervelib/imu/ADIS16470Swerve.html +++ b/docs/swervelib/imu/ADIS16470Swerve.html @@ -1,7 +1,7 @@ - + ADIS16470Swerve diff --git a/docs/swervelib/imu/ADXRS450Swerve.html b/docs/swervelib/imu/ADXRS450Swerve.html index 5f1d814..b2ef00d 100644 --- a/docs/swervelib/imu/ADXRS450Swerve.html +++ b/docs/swervelib/imu/ADXRS450Swerve.html @@ -1,7 +1,7 @@ - + ADXRS450Swerve diff --git a/docs/swervelib/imu/AnalogGyroSwerve.html b/docs/swervelib/imu/AnalogGyroSwerve.html index b3f408f..30c182a 100644 --- a/docs/swervelib/imu/AnalogGyroSwerve.html +++ b/docs/swervelib/imu/AnalogGyroSwerve.html @@ -1,7 +1,7 @@ - + AnalogGyroSwerve diff --git a/docs/swervelib/imu/NavXSwerve.html b/docs/swervelib/imu/NavXSwerve.html index 07ff6a2..e14a407 100644 --- a/docs/swervelib/imu/NavXSwerve.html +++ b/docs/swervelib/imu/NavXSwerve.html @@ -1,7 +1,7 @@ - + NavXSwerve diff --git a/docs/swervelib/imu/Pigeon2Swerve.html b/docs/swervelib/imu/Pigeon2Swerve.html index a455a05..b15469e 100644 --- a/docs/swervelib/imu/Pigeon2Swerve.html +++ b/docs/swervelib/imu/Pigeon2Swerve.html @@ -1,7 +1,7 @@ - + Pigeon2Swerve diff --git a/docs/swervelib/imu/PigeonSwerve.html b/docs/swervelib/imu/PigeonSwerve.html index 98652f1..6d389e0 100644 --- a/docs/swervelib/imu/PigeonSwerve.html +++ b/docs/swervelib/imu/PigeonSwerve.html @@ -1,7 +1,7 @@ - + PigeonSwerve diff --git a/docs/swervelib/imu/SwerveIMU.html b/docs/swervelib/imu/SwerveIMU.html index 221677b..b460503 100644 --- a/docs/swervelib/imu/SwerveIMU.html +++ b/docs/swervelib/imu/SwerveIMU.html @@ -1,7 +1,7 @@ - + SwerveIMU diff --git a/docs/swervelib/imu/package-summary.html b/docs/swervelib/imu/package-summary.html index 3bf5d53..8129da1 100644 --- a/docs/swervelib/imu/package-summary.html +++ b/docs/swervelib/imu/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.imu diff --git a/docs/swervelib/imu/package-tree.html b/docs/swervelib/imu/package-tree.html index e240e6a..7e03544 100644 --- a/docs/swervelib/imu/package-tree.html +++ b/docs/swervelib/imu/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.imu Class Hierarchy diff --git a/docs/swervelib/math/Matter.html b/docs/swervelib/math/Matter.html index 86ab6cc..903074d 100644 --- a/docs/swervelib/math/Matter.html +++ b/docs/swervelib/math/Matter.html @@ -1,7 +1,7 @@ - + Matter diff --git a/docs/swervelib/math/SwerveDriveOdometry2.html b/docs/swervelib/math/SwerveDriveOdometry2.html index f45bd10..01eed5f 100644 --- a/docs/swervelib/math/SwerveDriveOdometry2.html +++ b/docs/swervelib/math/SwerveDriveOdometry2.html @@ -1,7 +1,7 @@ - + SwerveDriveOdometry2 diff --git a/docs/swervelib/math/SwerveKinematics2.html b/docs/swervelib/math/SwerveKinematics2.html index f13b123..fe6e77a 100644 --- a/docs/swervelib/math/SwerveKinematics2.html +++ b/docs/swervelib/math/SwerveKinematics2.html @@ -1,7 +1,7 @@ - + SwerveKinematics2 diff --git a/docs/swervelib/math/SwerveMath.html b/docs/swervelib/math/SwerveMath.html index a5b498a..eb24271 100644 --- a/docs/swervelib/math/SwerveMath.html +++ b/docs/swervelib/math/SwerveMath.html @@ -1,7 +1,7 @@ - + SwerveMath @@ -371,6 +371,8 @@ loadScripts(document, 'script');
Parameters:
transform - Pose to perform the log on.
+
Returns:
+
Twist2d of the transformed pose.
diff --git a/docs/swervelib/math/SwerveModuleState2.html b/docs/swervelib/math/SwerveModuleState2.html index 7608815..d1654f0 100644 --- a/docs/swervelib/math/SwerveModuleState2.html +++ b/docs/swervelib/math/SwerveModuleState2.html @@ -1,7 +1,7 @@ - + SwerveModuleState2 diff --git a/docs/swervelib/math/SwervePoseEstimator2.InterpolationRecord.html b/docs/swervelib/math/SwervePoseEstimator2.InterpolationRecord.html index 05d6355..4f7cec5 100644 --- a/docs/swervelib/math/SwervePoseEstimator2.InterpolationRecord.html +++ b/docs/swervelib/math/SwervePoseEstimator2.InterpolationRecord.html @@ -1,7 +1,7 @@ - + SwervePoseEstimator2.InterpolationRecord diff --git a/docs/swervelib/math/SwervePoseEstimator2.html b/docs/swervelib/math/SwervePoseEstimator2.html index 745d2ba..643db77 100644 --- a/docs/swervelib/math/SwervePoseEstimator2.html +++ b/docs/swervelib/math/SwervePoseEstimator2.html @@ -1,7 +1,7 @@ - + SwervePoseEstimator2 diff --git a/docs/swervelib/math/package-summary.html b/docs/swervelib/math/package-summary.html index 3e8d306..4462537 100644 --- a/docs/swervelib/math/package-summary.html +++ b/docs/swervelib/math/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.math diff --git a/docs/swervelib/math/package-tree.html b/docs/swervelib/math/package-tree.html index 1d307a4..ccb2403 100644 --- a/docs/swervelib/math/package-tree.html +++ b/docs/swervelib/math/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.math Class Hierarchy diff --git a/docs/swervelib/motors/SparkMaxBrushedMotorSwerve.html b/docs/swervelib/motors/SparkMaxBrushedMotorSwerve.html index ff258fa..8b446a6 100644 --- a/docs/swervelib/motors/SparkMaxBrushedMotorSwerve.html +++ b/docs/swervelib/motors/SparkMaxBrushedMotorSwerve.html @@ -1,7 +1,7 @@ - + SparkMaxBrushedMotorSwerve diff --git a/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html b/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html index 8015539..e09002d 100644 --- a/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html +++ b/docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html @@ -1,7 +1,7 @@ - + SparkMaxSwerve.SparkMAX_slotIdx diff --git a/docs/swervelib/motors/SparkMaxSwerve.html b/docs/swervelib/motors/SparkMaxSwerve.html index 5fefb06..9d5719a 100644 --- a/docs/swervelib/motors/SparkMaxSwerve.html +++ b/docs/swervelib/motors/SparkMaxSwerve.html @@ -1,7 +1,7 @@ - + SparkMaxSwerve diff --git a/docs/swervelib/motors/SwerveMotor.html b/docs/swervelib/motors/SwerveMotor.html index 844c55d..237e931 100644 --- a/docs/swervelib/motors/SwerveMotor.html +++ b/docs/swervelib/motors/SwerveMotor.html @@ -1,7 +1,7 @@ - + SwerveMotor diff --git a/docs/swervelib/motors/TalonFXSwerve.html b/docs/swervelib/motors/TalonFXSwerve.html index 6e2a800..792d6ef 100644 --- a/docs/swervelib/motors/TalonFXSwerve.html +++ b/docs/swervelib/motors/TalonFXSwerve.html @@ -1,7 +1,7 @@ - + TalonFXSwerve diff --git a/docs/swervelib/motors/TalonSRXSwerve.html b/docs/swervelib/motors/TalonSRXSwerve.html index 13f46b0..a453ff8 100644 --- a/docs/swervelib/motors/TalonSRXSwerve.html +++ b/docs/swervelib/motors/TalonSRXSwerve.html @@ -1,7 +1,7 @@ - + TalonSRXSwerve diff --git a/docs/swervelib/motors/package-summary.html b/docs/swervelib/motors/package-summary.html index dfbd27e..c3edcaa 100644 --- a/docs/swervelib/motors/package-summary.html +++ b/docs/swervelib/motors/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.motors diff --git a/docs/swervelib/motors/package-tree.html b/docs/swervelib/motors/package-tree.html index dac1592..c1a7335 100644 --- a/docs/swervelib/motors/package-tree.html +++ b/docs/swervelib/motors/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.motors Class Hierarchy diff --git a/docs/swervelib/package-summary.html b/docs/swervelib/package-summary.html index e51ae98..3f07f8d 100644 --- a/docs/swervelib/package-summary.html +++ b/docs/swervelib/package-summary.html @@ -1,7 +1,7 @@ - + swervelib diff --git a/docs/swervelib/package-tree.html b/docs/swervelib/package-tree.html index 9c900e2..8e35d2c 100644 --- a/docs/swervelib/package-tree.html +++ b/docs/swervelib/package-tree.html @@ -1,7 +1,7 @@ - + swervelib Class Hierarchy diff --git a/docs/swervelib/parser/PIDFConfig.html b/docs/swervelib/parser/PIDFConfig.html index 6bff2ac..9a91641 100644 --- a/docs/swervelib/parser/PIDFConfig.html +++ b/docs/swervelib/parser/PIDFConfig.html @@ -1,7 +1,7 @@ - + PIDFConfig diff --git a/docs/swervelib/parser/SwerveControllerConfiguration.html b/docs/swervelib/parser/SwerveControllerConfiguration.html index 4d2325d..3544f85 100644 --- a/docs/swervelib/parser/SwerveControllerConfiguration.html +++ b/docs/swervelib/parser/SwerveControllerConfiguration.html @@ -1,7 +1,7 @@ - + SwerveControllerConfiguration diff --git a/docs/swervelib/parser/SwerveDriveConfiguration.html b/docs/swervelib/parser/SwerveDriveConfiguration.html index 9d5116a..fc6432e 100644 --- a/docs/swervelib/parser/SwerveDriveConfiguration.html +++ b/docs/swervelib/parser/SwerveDriveConfiguration.html @@ -1,7 +1,7 @@ - + SwerveDriveConfiguration diff --git a/docs/swervelib/parser/SwerveModuleConfiguration.html b/docs/swervelib/parser/SwerveModuleConfiguration.html index cdca40d..52f4ad1 100644 --- a/docs/swervelib/parser/SwerveModuleConfiguration.html +++ b/docs/swervelib/parser/SwerveModuleConfiguration.html @@ -1,7 +1,7 @@ - + SwerveModuleConfiguration @@ -398,6 +398,7 @@ loadScripts(document, 'script');
maxSpeed - Maximum speed in meters per second.
physicalCharacteristics - Physical characteristics of the swerve module.
angleMotorEncoderPulsePerRevolution - The encoder pulse per revolution for the angle motor encoder.
+
name - The name for the swerve module.
diff --git a/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html b/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html index 9e73f4f..0d046a6 100644 --- a/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html +++ b/docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html @@ -1,7 +1,7 @@ - + SwerveModulePhysicalCharacteristics diff --git a/docs/swervelib/parser/SwerveParser.html b/docs/swervelib/parser/SwerveParser.html index 2a05717..393432d 100644 --- a/docs/swervelib/parser/SwerveParser.html +++ b/docs/swervelib/parser/SwerveParser.html @@ -1,7 +1,7 @@ - + SwerveParser diff --git a/docs/swervelib/parser/deserializer/PIDFRange.html b/docs/swervelib/parser/deserializer/PIDFRange.html index 3785faa..8a2354f 100644 --- a/docs/swervelib/parser/deserializer/PIDFRange.html +++ b/docs/swervelib/parser/deserializer/PIDFRange.html @@ -1,7 +1,7 @@ - + PIDFRange diff --git a/docs/swervelib/parser/deserializer/package-summary.html b/docs/swervelib/parser/deserializer/package-summary.html index dfd812e..9fee906 100644 --- a/docs/swervelib/parser/deserializer/package-summary.html +++ b/docs/swervelib/parser/deserializer/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser.deserializer diff --git a/docs/swervelib/parser/deserializer/package-tree.html b/docs/swervelib/parser/deserializer/package-tree.html index 3c8bd8a..a597797 100644 --- a/docs/swervelib/parser/deserializer/package-tree.html +++ b/docs/swervelib/parser/deserializer/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser.deserializer Class Hierarchy diff --git a/docs/swervelib/parser/json/ControllerPropertiesJson.html b/docs/swervelib/parser/json/ControllerPropertiesJson.html index ee62765..f52ae3e 100644 --- a/docs/swervelib/parser/json/ControllerPropertiesJson.html +++ b/docs/swervelib/parser/json/ControllerPropertiesJson.html @@ -1,7 +1,7 @@ - + ControllerPropertiesJson diff --git a/docs/swervelib/parser/json/DeviceJson.html b/docs/swervelib/parser/json/DeviceJson.html index 48c1ef5..1178c95 100644 --- a/docs/swervelib/parser/json/DeviceJson.html +++ b/docs/swervelib/parser/json/DeviceJson.html @@ -1,7 +1,7 @@ - + DeviceJson diff --git a/docs/swervelib/parser/json/ModuleJson.html b/docs/swervelib/parser/json/ModuleJson.html index f0c9de5..8ffd823 100644 --- a/docs/swervelib/parser/json/ModuleJson.html +++ b/docs/swervelib/parser/json/ModuleJson.html @@ -1,7 +1,7 @@ - + ModuleJson diff --git a/docs/swervelib/parser/json/MotorConfigDouble.html b/docs/swervelib/parser/json/MotorConfigDouble.html index 518f52b..3d8ab18 100644 --- a/docs/swervelib/parser/json/MotorConfigDouble.html +++ b/docs/swervelib/parser/json/MotorConfigDouble.html @@ -1,7 +1,7 @@ - + MotorConfigDouble diff --git a/docs/swervelib/parser/json/MotorConfigInt.html b/docs/swervelib/parser/json/MotorConfigInt.html index 472e785..c45e202 100644 --- a/docs/swervelib/parser/json/MotorConfigInt.html +++ b/docs/swervelib/parser/json/MotorConfigInt.html @@ -1,7 +1,7 @@ - + MotorConfigInt diff --git a/docs/swervelib/parser/json/PIDFPropertiesJson.html b/docs/swervelib/parser/json/PIDFPropertiesJson.html index 2d1fa2b..da8fa21 100644 --- a/docs/swervelib/parser/json/PIDFPropertiesJson.html +++ b/docs/swervelib/parser/json/PIDFPropertiesJson.html @@ -1,7 +1,7 @@ - + PIDFPropertiesJson diff --git a/docs/swervelib/parser/json/PhysicalPropertiesJson.html b/docs/swervelib/parser/json/PhysicalPropertiesJson.html index 26e0273..66c5e43 100644 --- a/docs/swervelib/parser/json/PhysicalPropertiesJson.html +++ b/docs/swervelib/parser/json/PhysicalPropertiesJson.html @@ -1,7 +1,7 @@ - + PhysicalPropertiesJson diff --git a/docs/swervelib/parser/json/SwerveDriveJson.html b/docs/swervelib/parser/json/SwerveDriveJson.html index 0fd36bd..523512d 100644 --- a/docs/swervelib/parser/json/SwerveDriveJson.html +++ b/docs/swervelib/parser/json/SwerveDriveJson.html @@ -1,7 +1,7 @@ - + SwerveDriveJson diff --git a/docs/swervelib/parser/json/modules/BoolMotorJson.html b/docs/swervelib/parser/json/modules/BoolMotorJson.html index 3c7ff05..5b43542 100644 --- a/docs/swervelib/parser/json/modules/BoolMotorJson.html +++ b/docs/swervelib/parser/json/modules/BoolMotorJson.html @@ -1,7 +1,7 @@ - + BoolMotorJson diff --git a/docs/swervelib/parser/json/modules/LocationJson.html b/docs/swervelib/parser/json/modules/LocationJson.html index cad82f4..58df7a7 100644 --- a/docs/swervelib/parser/json/modules/LocationJson.html +++ b/docs/swervelib/parser/json/modules/LocationJson.html @@ -1,7 +1,7 @@ - + LocationJson diff --git a/docs/swervelib/parser/json/modules/package-summary.html b/docs/swervelib/parser/json/modules/package-summary.html index cfc0eea..e16db42 100644 --- a/docs/swervelib/parser/json/modules/package-summary.html +++ b/docs/swervelib/parser/json/modules/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser.json.modules diff --git a/docs/swervelib/parser/json/modules/package-tree.html b/docs/swervelib/parser/json/modules/package-tree.html index d88b959..e672d62 100644 --- a/docs/swervelib/parser/json/modules/package-tree.html +++ b/docs/swervelib/parser/json/modules/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser.json.modules Class Hierarchy diff --git a/docs/swervelib/parser/json/package-summary.html b/docs/swervelib/parser/json/package-summary.html index 5772d31..d684f6e 100644 --- a/docs/swervelib/parser/json/package-summary.html +++ b/docs/swervelib/parser/json/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser.json diff --git a/docs/swervelib/parser/json/package-tree.html b/docs/swervelib/parser/json/package-tree.html index 6da2226..117902d 100644 --- a/docs/swervelib/parser/json/package-tree.html +++ b/docs/swervelib/parser/json/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser.json Class Hierarchy diff --git a/docs/swervelib/parser/package-summary.html b/docs/swervelib/parser/package-summary.html index 2b87cc1..273e18d 100644 --- a/docs/swervelib/parser/package-summary.html +++ b/docs/swervelib/parser/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.parser diff --git a/docs/swervelib/parser/package-tree.html b/docs/swervelib/parser/package-tree.html index eb9e0a2..c323d60 100644 --- a/docs/swervelib/parser/package-tree.html +++ b/docs/swervelib/parser/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.parser Class Hierarchy diff --git a/docs/swervelib/simulation/SwerveIMUSimulation.html b/docs/swervelib/simulation/SwerveIMUSimulation.html index dbd7645..2e00551 100644 --- a/docs/swervelib/simulation/SwerveIMUSimulation.html +++ b/docs/swervelib/simulation/SwerveIMUSimulation.html @@ -1,7 +1,7 @@ - + SwerveIMUSimulation diff --git a/docs/swervelib/simulation/SwerveModuleSimulation.html b/docs/swervelib/simulation/SwerveModuleSimulation.html index d05fe1e..7a1fd55 100644 --- a/docs/swervelib/simulation/SwerveModuleSimulation.html +++ b/docs/swervelib/simulation/SwerveModuleSimulation.html @@ -1,7 +1,7 @@ - + SwerveModuleSimulation diff --git a/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html b/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html index 010f9f9..80cf152 100644 --- a/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html +++ b/docs/swervelib/simulation/ctre/PhysicsSim.SimProfile.html @@ -1,7 +1,7 @@ - + PhysicsSim.SimProfile diff --git a/docs/swervelib/simulation/ctre/PhysicsSim.html b/docs/swervelib/simulation/ctre/PhysicsSim.html index aa12b9c..0679d25 100644 --- a/docs/swervelib/simulation/ctre/PhysicsSim.html +++ b/docs/swervelib/simulation/ctre/PhysicsSim.html @@ -1,7 +1,7 @@ - + PhysicsSim diff --git a/docs/swervelib/simulation/ctre/TalonFXSimProfile.html b/docs/swervelib/simulation/ctre/TalonFXSimProfile.html index 5e25f52..e86db14 100644 --- a/docs/swervelib/simulation/ctre/TalonFXSimProfile.html +++ b/docs/swervelib/simulation/ctre/TalonFXSimProfile.html @@ -1,7 +1,7 @@ - + TalonFXSimProfile diff --git a/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html b/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html index 74dcf17..4ba2296 100644 --- a/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html +++ b/docs/swervelib/simulation/ctre/TalonSRXSimProfile.html @@ -1,7 +1,7 @@ - + TalonSRXSimProfile diff --git a/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html b/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html index 8bd67d2..01ab22d 100644 --- a/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html +++ b/docs/swervelib/simulation/ctre/VictorSPXSimProfile.html @@ -1,7 +1,7 @@ - + VictorSPXSimProfile diff --git a/docs/swervelib/simulation/ctre/package-summary.html b/docs/swervelib/simulation/ctre/package-summary.html index 2f1e676..5ec6ef9 100644 --- a/docs/swervelib/simulation/ctre/package-summary.html +++ b/docs/swervelib/simulation/ctre/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.simulation.ctre diff --git a/docs/swervelib/simulation/ctre/package-tree.html b/docs/swervelib/simulation/ctre/package-tree.html index 131b5be..7fb801c 100644 --- a/docs/swervelib/simulation/ctre/package-tree.html +++ b/docs/swervelib/simulation/ctre/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.simulation.ctre Class Hierarchy diff --git a/docs/swervelib/simulation/package-summary.html b/docs/swervelib/simulation/package-summary.html index 688a905..9028a69 100644 --- a/docs/swervelib/simulation/package-summary.html +++ b/docs/swervelib/simulation/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.simulation diff --git a/docs/swervelib/simulation/package-tree.html b/docs/swervelib/simulation/package-tree.html index 408daa9..4edcc9b 100644 --- a/docs/swervelib/simulation/package-tree.html +++ b/docs/swervelib/simulation/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.simulation Class Hierarchy diff --git a/docs/swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html b/docs/swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html index b70ea94..f154b6c 100644 --- a/docs/swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html +++ b/docs/swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html @@ -1,7 +1,7 @@ - + SwerveDriveTelemetry.TelemetryVerbosity diff --git a/docs/swervelib/telemetry/SwerveDriveTelemetry.html b/docs/swervelib/telemetry/SwerveDriveTelemetry.html index 7b17f15..9c04d4d 100644 --- a/docs/swervelib/telemetry/SwerveDriveTelemetry.html +++ b/docs/swervelib/telemetry/SwerveDriveTelemetry.html @@ -1,7 +1,7 @@ - + SwerveDriveTelemetry diff --git a/docs/swervelib/telemetry/package-summary.html b/docs/swervelib/telemetry/package-summary.html index 2320b82..d72e78b 100644 --- a/docs/swervelib/telemetry/package-summary.html +++ b/docs/swervelib/telemetry/package-summary.html @@ -1,7 +1,7 @@ - + swervelib.telemetry diff --git a/docs/swervelib/telemetry/package-tree.html b/docs/swervelib/telemetry/package-tree.html index 37c04e2..dec5020 100644 --- a/docs/swervelib/telemetry/package-tree.html +++ b/docs/swervelib/telemetry/package-tree.html @@ -1,7 +1,7 @@ - + swervelib.telemetry Class Hierarchy diff --git a/swervelib/math/SwerveMath.java b/swervelib/math/SwerveMath.java index a098ce4..2637e63 100644 --- a/swervelib/math/SwerveMath.java +++ b/swervelib/math/SwerveMath.java @@ -203,6 +203,7 @@ public class SwerveMath * Logical inverse of the Pose exponential from 254. Taken from team 3181. * * @param transform Pose to perform the log on. + * @return {@link Twist2d} of the transformed pose. */ public static Twist2d PoseLog(final Pose2d transform) { diff --git a/swervelib/parser/SwerveModuleConfiguration.java b/swervelib/parser/SwerveModuleConfiguration.java index 0f2440a..d3d27c1 100644 --- a/swervelib/parser/SwerveModuleConfiguration.java +++ b/swervelib/parser/SwerveModuleConfiguration.java @@ -89,6 +89,7 @@ public class SwerveModuleConfiguration * @param maxSpeed Maximum speed in meters per second. * @param physicalCharacteristics Physical characteristics of the swerve module. * @param angleMotorEncoderPulsePerRevolution The encoder pulse per revolution for the angle motor encoder. + * @param name The name for the swerve module. */ public SwerveModuleConfiguration( SwerveMotor driveMotor,