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

@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Feb 15 00:08:08 CST 2023 -->
<!-- Generated by javadoc (17) on Wed Feb 15 22:17:49 CST 2023 -->
<title>All Classes and Interfaces</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -60,6 +60,22 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">IMU Swerve class for the <code>ADIS16448_IMU</code> device.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">IMU Swerve class for the <code>ADIS16470_IMU</code> device.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">IMU Swerve class for the <code>ADXRS450_Gyro</code> device.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Creates a IMU for <code>AnalogGyro</code> devices, only uses yaw.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Inverted motor JSON parsed class.</div>
@@ -160,27 +176,35 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Simulation for <a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
speed.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Mathematical functions which pertain to swerve drive.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Module configuration class which is used to configure <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Class to hold simulation data for <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Second order kinematics swerve module state.</div>