Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-06-19 06:21:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated to YAGSL 2024

Browse Source
This commit is contained in:
thenetworkgrinch
2024-01-15 14:39:17 -06:00
parent a71d7a0b4e
commit c339d2f482
125 changed files with 6918 additions and 854 deletions
Download Patch File Download Diff File Expand all files Collapse all files

196
docs/allclasses-index.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>All Classes and Interfaces (YAGSL-Example API)</title> <title>All Classes and Interfaces</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="class index"> <meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter"> <meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script> <script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="all-classes-index-page"> <body class="all-classes-index-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li>Package</li> <li>Package</li>
<li>Class</li> <li>Class</li>
<li><a href="overview-tree.html">Tree</a></li> <li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li> <li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html#all-classes">Help</a></li> <li><a href="help-doc.html#all-classes">Help</a></li>
</ul> </ul>
</div> </div>
@@ -59,41 +60,25 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0"> <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-first">Class</div>
<div class="table-header col-last">Description</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="frc/robot/commands/swervedrive/drivebase/AbsoluteDrive.html" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDrive</a></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="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">An example command that uses an example subsystem.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/swervedrive/drivebase/AbsoluteDriveAdv.html" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDriveAdv</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">A more advanced Swerve Control System that has 4 buttons for which direction to face</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/swervedrive/drivebase/AbsoluteFieldDrive.html" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteFieldDrive</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">An example command that uses an example subsystem.</div>
</div>
<div class="col-first odd-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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">IMU Swerve class for the <code>ADIS16448_IMU</code> device.</div> <div class="block">IMU Swerve class for the <code>ADIS16448_IMU</code> device.</div>
</div> </div>
<div class="col-first even-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-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 even-row-color all-classes-table all-classes-table-tab2"> <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 class="block">IMU Swerve class for the <code>ADIS16470_IMU</code> device.</div>
</div> </div>
<div class="col-first odd-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-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 odd-row-color all-classes-table all-classes-table-tab2"> <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 class="block">IMU Swerve class for the <code>ADXRS450_Gyro</code> device.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div> <div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
</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-first even-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="frc/robot/commands/swervedrive/auto/AutoBalanceCommand.html" title="class in frc.robot.commands.swervedrive.auto">AutoBalanceCommand</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Auto Balance command using a simple PID controller.</div> <div class="block">Creates a IMU for <code>AnalogGyro</code> devices, only uses yaw.</div>
</div> </div>
<div class="col-first odd-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-first odd-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 odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
@@ -107,16 +92,6 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div> <div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.html" title="class in frc.robot">Constants</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean constants.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Auton.html" title="class in frc.robot">Constants.Auton</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Drivebase.html" title="class in frc.robot">Constants.Drivebase</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.OperatorConstants.html" title="class in frc.robot">Constants.OperatorConstants</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div> <div class="block"><a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div>
@@ -129,72 +104,63 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Location JSON parsed class.</div> <div class="block">Location JSON parsed class.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Main.html" title="class in frc.robot">Main</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Do NOT add any static variables to this class, or any initialization at all.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Object with significant mass that needs to be taken into account.</div> <div class="block">Object with significant mass that needs to be taken into account.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div> <div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Used to store doubles for motor configuration.</div> <div class="block">Used to store doubles for motor configuration.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Used to store ints for motor configuration.</div> <div class="block">Used to store ints for motor configuration.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Communicates with the NavX as the IMU.</div> <div class="block">Communicates with the NavX as the IMU.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div> <div class="block"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div> <div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div> <div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div> <div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">SwerveIMU interface for the Pigeon2</div> <div class="block">SwerveIMU interface for the Pigeon2</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">SwerveIMU interface for the Pigeon.</div> <div class="block">SwerveIMU interface for the Pigeon.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag <div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
Encoder." attached via a PWM lane.</div> Encoder." attached via a PWM lane.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The VM is configured to automatically run this class, and to call the functions corresponding to each mode, as
described in the TimedRobot documentation.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/RobotContainer.html" title="class in frc.robot">RobotContainer</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">This class is where the bulk of the robot should be declared.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">An implementation of <code>CANSparkFlex</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div> <div class="block">An implementation of <code>CANSparkFlex</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">REV Slots for PID configuration.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div> <div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div>
@@ -211,76 +177,78 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div> <div class="block">An implementation of <code>CANSparkMax</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">REV Slots for PID configuration.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div> <div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Controller class used to convert raw inputs into robot speeds.</div> <div class="block">Controller class used to convert raw inputs into robot speeds.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Controller configuration class which is used to configure <a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div> <div class="block">Swerve Controller configuration class which is used to configure <a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div> <div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div> <div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block"><a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div> <div class="block"><a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Telemetry to describe the <a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> following frc-web-components.</div> <div class="block">Telemetry to describe the <a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> following frc-web-components.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="block">Verbosity of telemetry data sent back.</div> <div class="block">Verbosity of telemetry data sent back.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <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 class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
</div> </div>
<div class="col-first even-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-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 even-row-color all-classes-table all-classes-table-tab2"> <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 class="block">Simulation for <a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
</div> </div>
<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-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 odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Mathematical functions which pertain to swerve drive.</div> <div class="block">Mathematical functions which pertain to swerve drive.</div>
</div> </div>
<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-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 even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-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 class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</div> </div>
<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-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 odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-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 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>
<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-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 even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-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 class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</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-first even-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="col-last even-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 class="block">Class to hold simulation data for <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div> <div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></div> <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div> <div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
</div> </div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div> <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> <div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block"><code>TalonFX</code> Swerve Motor.</div> <div class="block"><code>TalonFX</code> Swerve Motor.</div>
@@ -289,10 +257,6 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2"> <div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div> <div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
</div> </div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/swervedrive/drivebase/TeleopDrive.html" title="class in frc.robot.commands.swervedrive.drivebase">TeleopDrive</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">An example command that uses an example subsystem.</div>
</div>
</div> </div>
</div> </div>
</div> </div>

17
docs/allpackages-index.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>All Packages (YAGSL-Example API)</title> <title>All Packages</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="package index"> <meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter"> <meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script> <script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="all-packages-index-page"> <body class="all-packages-index-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li>Package</li> <li>Package</li>
<li>Class</li> <li>Class</li>
<li><a href="overview-tree.html">Tree</a></li> <li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li> <li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html#all-packages">Help</a></li> <li><a href="help-doc.html#all-packages">Help</a></li>
</ul> </ul>
</div> </div>
@@ -53,14 +54,6 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary"> <div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div> <div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div> <div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="frc/robot/package-summary.html">frc.robot</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/commands/swervedrive/auto/package-summary.html">frc.robot.commands.swervedrive.auto</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/commands/swervedrive/drivebase/package-summary.html">frc.robot.commands.swervedrive.drivebase</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/swervedrive/package-summary.html">frc.robot.subsystems.swervedrive</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="swervelib/package-summary.html">swervelib</a></div> <div class="col-first even-row-color"><a href="swervelib/package-summary.html">swervelib</a></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div> <div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>

96
docs/constant-values.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Constant Field Values (YAGSL-Example API)</title> <title>Constant Field Values</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="summary of constants"> <meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl"> <meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script> <script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="constants-summary-page"> <body class="constants-summary-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li>Package</li> <li>Package</li>
<li>Class</li> <li>Class</li>
<li><a href="overview-tree.html">Tree</a></li> <li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li> <li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html#constant-values">Help</a></li> <li><a href="help-doc.html#constant-values">Help</a></li>
</ul> </ul>
</div> </div>
@@ -51,69 +52,22 @@ loadScripts(document, 'script');</script>
<section class="packages"> <section class="packages">
<h2 title="Contents">Contents</h2> <h2 title="Contents">Contents</h2>
<ul> <ul>
<li><a href="#frc.robot">frc.robot.*</a></li> <li><a href="#swervelib">swervelib.*</a></li>
<li><a href="#swervelib.encoders">swervelib.encoders.*</a></li>
<li><a href="#swervelib.motors">swervelib.motors.*</a></li>
</ul> </ul>
</section> </section>
</div> </div>
<section class="constants-summary" id="frc.robot"> <section class="constants-summary" id="swervelib">
<h2 title="frc.robot">frc.robot.*</h2> <h2 title="swervelib">swervelib.*</h2>
<ul class="block-list"> <ul class="block-list">
<li> <li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.html" title="class in frc.robot">Constants</a></span></div> <div class="caption"><span>swervelib.<a href="swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span></div>
<div class="summary-table three-column-summary"> <div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div> <div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div> <div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div> <div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.LOOP_TIME">public&nbsp;static&nbsp;final&nbsp;double</code></div> <div class="col-first even-row-color"><code id="swervelib.SwerveDrive.HEADING_CORRECTION_DEADBAND">private&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.html#LOOP_TIME">LOOP_TIME</a></code></div> <div class="col-second even-row-color"><code><a href="swervelib/SwerveDrive.html#HEADING_CORRECTION_DEADBAND">HEADING_CORRECTION_DEADBAND</a></code></div>
<div class="col-last even-row-color"><code>0.13</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.ROBOT_MASS">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.html#ROBOT_MASS">ROBOT_MASS</a></code></div>
<div class="col-last odd-row-color"><code>57.9236984</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.Auton.html" title="class in frc.robot">Constants.Auton</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Auton.MAX_ACCELERATION">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Auton.html#MAX_ACCELERATION">MAX_ACCELERATION</a></code></div>
<div class="col-last even-row-color"><code>2.0</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.Drivebase.html" title="class in frc.robot">Constants.Drivebase</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Drivebase.WHEEL_LOCK_TIME">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Drivebase.html#WHEEL_LOCK_TIME">WHEEL_LOCK_TIME</a></code></div>
<div class="col-last even-row-color"><code>10.0</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.OperatorConstants.html" title="class in frc.robot">Constants.OperatorConstants</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.OperatorConstants.LEFT_X_DEADBAND">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.OperatorConstants.html#LEFT_X_DEADBAND">LEFT_X_DEADBAND</a></code></div>
<div class="col-last even-row-color"><code>0.01</code></div> <div class="col-last even-row-color"><code>0.01</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.OperatorConstants.LEFT_Y_DEADBAND">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.OperatorConstants.html#LEFT_Y_DEADBAND">LEFT_Y_DEADBAND</a></code></div>
<div class="col-last odd-row-color"><code>0.01</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.OperatorConstants.RIGHT_X_DEADBAND">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.OperatorConstants.html#RIGHT_X_DEADBAND">RIGHT_X_DEADBAND</a></code></div>
<div class="col-last even-row-color"><code>0.01</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.OperatorConstants.TURN_CONSTANT">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.OperatorConstants.html#TURN_CONSTANT">TURN_CONSTANT</a></code></div>
<div class="col-last odd-row-color"><code>0.75</code></div>
</div> </div>
</li> </li>
</ul> </ul>
@@ -148,6 +102,34 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color"><code>5</code></div> <div class="col-last even-row-color"><code>5</code></div>
</div> </div>
</li> </li>
<li>
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="swervelib.motors.TalonFXSwerve.absoluteEncoder">private&nbsp;final&nbsp;boolean</code></div>
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#absoluteEncoder">absoluteEncoder</a></code></div>
<div class="col-last even-row-color"><code>false</code></div>
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonFXSwerve.factoryDefaultOccurred">private&nbsp;final&nbsp;boolean</code></div>
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
<div class="col-last odd-row-color"><code>false</code></div>
</div>
</li>
<li>
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="swervelib.motors.TalonSRXSwerve.absoluteEncoder">private&nbsp;final&nbsp;boolean</code></div>
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonSRXSwerve.html#absoluteEncoder">absoluteEncoder</a></code></div>
<div class="col-last even-row-color"><code>false</code></div>
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonSRXSwerve.factoryDefaultOccurred">private&nbsp;final&nbsp;boolean</code></div>
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonSRXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
<div class="col-last odd-row-color"><code>false</code></div>
</div>
</li>
</ul> </ul>
</section> </section>
</main> </main>

4
docs/element-list
View File

@@ -1,7 +1,3 @@
frc.robot
frc.robot.commands.swervedrive.auto
frc.robot.commands.swervedrive.drivebase
frc.robot.subsystems.swervedrive
swervelib swervelib
swervelib.encoders swervelib.encoders
swervelib.imu swervelib.imu

13
docs/help-doc.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>API Help (YAGSL-Example API)</title> <title>API Help</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="help"> <meta name="description" content="help">
<meta name="generator" content="javadoc/HelpWriter"> <meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script> <script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="help-page"> <body class="help-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li>Package</li> <li>Package</li>
<li>Class</li> <li>Class</li>
<li><a href="overview-tree.html">Tree</a></li> <li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li> <li><a href="index-files/index-1.html">Index</a></li>
<li class="nav-bar-cell1-rev">Help</li> <li class="nav-bar-cell1-rev">Help</li>
</ul> </ul>
</div> </div>
@@ -77,7 +78,7 @@ loadScripts(document, 'script');</script>
<hr> <hr>
<div class="sub-title"> <div class="sub-title">
<h2 id="help-navigation">Navigation</h2> <h2 id="help-navigation">Navigation</h2>
Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a> Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-files/index-1.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>
<section class="help-section" id="help-search"> <section class="help-section" id="help-search">
<h3>Search</h3> <h3>Search</h3>
<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p> <p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p>
@@ -169,7 +170,7 @@ The following sections describe the different kinds of pages in this collection.
</section> </section>
<section class="help-section" id="index"> <section class="help-section" id="index">
<h3>Index</h3> <h3>Index</h3>
<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p> <p>The <a href="index-files/index-1.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p>
</section> </section>
</div> </div>
<hr> <hr>

243
docs/index-files/index-1.html Normal file
View File

@@ -0,0 +1,243 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>A-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: A">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:A">A</h2>
<dl class="index">
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Whether the absolute encoder is integrated.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Whether the absolute encoder is integrated.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The Absolute Encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Absolute encoder for swerve drive.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Absolute encoder inversion state.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Whether the absolute encoder is inverted.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderOffset" class="member-name-link">absoluteEncoderOffset</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Absolute encoder offset from 0 in degrees.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#addSlewRateLimiters(edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter)" class="member-name-link">addSlewRateLimiters(SlewRateLimiter, SlewRateLimiter, SlewRateLimiter)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Add slew rate limiters to all controls.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double)" class="member-name-link">addVisionMeasurement(Pose2d, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
the given timestamp of the vision measurement.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, Matrix&lt;N3, N1&gt;)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
the given timestamp of the vision measurement.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html" class="type-name-link" title="class in swervelib.imu">ADIS16448Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">IMU Swerve class for the <code>ADIS16448_IMU</code> device.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#%3Cinit%3E()" class="member-name-link">ADIS16448Swerve()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Construct the ADIS16448 imu and reset default configurations.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html" class="type-name-link" title="class in swervelib.imu">ADIS16470Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">IMU Swerve class for the <code>ADIS16470_IMU</code> device.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#%3Cinit%3E()" class="member-name-link">ADIS16470Swerve()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Construct the ADIS16470 imu and reset default configurations.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html" class="type-name-link" title="class in swervelib.imu">ADXRS450Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">IMU Swerve class for the <code>ADXRS450_Gyro</code> device.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#%3Cinit%3E()" class="member-name-link">ADXRS450Swerve()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Construct the ADXRS450 imu and reset default configurations.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">AnalogAbsoluteEncoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Construct the Encoder given the analog input channel.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.AnalogInput)" class="member-name-link">AnalogAbsoluteEncoderSwerve(AnalogInput)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Construct the Thrifty Encoder as a Swerve Absolute Encoder.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html" class="type-name-link" title="class in swervelib.imu">AnalogGyroSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">Creates a IMU for <code>AnalogGyro</code> devices, only uses yaw.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#%3Cinit%3E(int)" class="member-name-link">AnalogGyroSwerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Analog port in which the gyroscope is connected.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Angle motor device configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
<dd>
<div class="block">Angle motor inversion state.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
<dd>
<div class="block">Angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
<dd>
<div class="block">Angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dd>
<div class="block">The PIDF with Integral Zone used for the angle motor.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Heading of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#angleJoystickRadiusDeadband" class="member-name-link">angleJoystickRadiusDeadband</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">The minimum radius of the angle control joystick to allow for heading adjustment of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#angleJoyStickRadiusDeadband" class="member-name-link">angleJoyStickRadiusDeadband</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">hypotenuse deadband for the robot angle control joystick.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#angleLimiter" class="member-name-link">angleLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block"><code>SlewRateLimiter</code> for angular movement in radians/second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The drive motor and angle motor of this swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Swerve Motors.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorCurrentLimit" class="member-name-link">angleMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Current limits for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorInverted" class="member-name-link">angleMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">State of inversion of the angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorRampRate" class="member-name-link">angleMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Angle offset in degrees for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Angle offset from the absolute encoder.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#anglePIDF" class="member-name-link">anglePIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#antiJitter(edu.wpi.first.math.kinematics.SwerveModuleState,edu.wpi.first.math.kinematics.SwerveModuleState,double)" class="member-name-link">antiJitter(SwerveModuleState, SwerveModuleState, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Perform anti-jitter within modules if the speed requested is too low.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#applyDeadband(double,boolean,double)" class="member-name-link">applyDeadband(double, boolean, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Algebraically apply a deadband using a piece wise function.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The absolute max speed the robot can reach while rotating radians per second.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The absolute max speed that your robot can reach while translating in meters per second.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

65
docs/index-files/index-10.html Normal file
View File

@@ -0,0 +1,65 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>K-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: K">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:K">K</h2>
<dl class="index">
<dt><a href="../swervelib/SwerveDrive.html#kinematics" class="member-name-link">kinematics</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve Kinematics object.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

107
docs/index-files/index-11.html Normal file
View File

@@ -0,0 +1,107 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>L-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: L">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:L">L</h2>
<dl class="index">
<dt><a href="../swervelib/SwerveController.html#lastAngleScalar" class="member-name-link">lastAngleScalar</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Last angle as a scalar [-1,1] the robot was set to.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The last heading set in radians.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#lastState" class="member-name-link">lastState</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Last swerve module state applied.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#lastTime" class="member-name-link">lastTime</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">The last time the timer was read, used to determine position changes.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#lastTime" class="member-name-link">lastTime</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Last time queried.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#left" class="member-name-link">left</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
<dd>
<div class="block">Location of the swerve module in inches from the center of the robot vertically.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity(Translation2d, ChassisSpeeds, Pose2d, double, double, List&lt;Matter&gt;, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>SwerveMath.calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List&lt;swervelib.math.Matter&gt;, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#location" class="member-name-link">location</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">The location of the swerve module from the center of the robot in inches.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
<dd>
<div class="block">Location JSON parsed class.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#%3Cinit%3E()" class="member-name-link">LocationJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/SwerveDrive.html#lockPose()" class="member-name-link">lockPose()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#LOW" class="member-name-link">LOW</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>
<div class="block">Low telemetry data, only post the robot position on the field.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

223
docs/index-files/index-12.html Normal file
View File

@@ -0,0 +1,223 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>M-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: M">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:M">M</h2>
<dl class="index">
<dt><a href="../swervelib/motors/TalonFXSwerve.html#m_angleVoltageSetter" class="member-name-link">m_angleVoltageSetter</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Motion magic angle voltage setter.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#m_velocityVoltageSetter" class="member-name-link">m_velocityVoltageSetter</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Velocity voltage setter for controlling drive motor.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#MACHINE" class="member-name-link">MACHINE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>
<div class="block">Only send the machine readable data related to swerve drive.</div>
</dd>
<dt><a href="../swervelib/math/Matter.html#mass" class="member-name-link">mass</a> - Variable in class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
<dd>
<div class="block">Mass in kg of object.</div>
</dd>
<dt><a href="../swervelib/math/Matter.html#massMoment()" class="member-name-link">massMoment()</a> - Method in class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
<dd>
<div class="block">Get the center mass of the object.</div>
</dd>
<dt><a href="../swervelib/math/Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
<dd>
<div class="block">Object with significant mass that needs to be taken into account.</div>
</dd>
<dt><a href="../swervelib/math/Matter.html#%3Cinit%3E(edu.wpi.first.math.geometry.Translation3d,double)" class="member-name-link">Matter(Translation3d, double)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
<dd>
<div class="block">Construct an object representing some significant matter on the robot.</div>
</dd>
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#max" class="member-name-link">max</a> - Variable in class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
<dd>
<div class="block">Maximum value.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#maxAngularVelocity" class="member-name-link">maxAngularVelocity</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Maximum angular velocity in rad/s</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#maxAngularVelocity" class="member-name-link">maxAngularVelocity</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable angular velocity of the robot.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#maximumRetries" class="member-name-link">maximumRetries</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">The maximum amount of times the swerve encoder will attempt to configure itself if failures occur.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#maximumRetries" class="member-name-link">maximumRetries</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">The maximum amount of times the swerve motor will attempt to configure a motor if failures occur.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Maximum speed of the drive motors in meters per second.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#maxSpeed" class="member-name-link">maxSpeed</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable speed of the modules, used to adjust the size of the vectors.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Maximum speed of the robot in meters per second.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredChassisSpeeds" class="member-name-link">measuredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable angular velocity of the robot.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredStates" class="member-name-link">measuredStates</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">An array of rotation and velocity values describing the measured state of each swerve module</div>
</dd>
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#min" class="member-name-link">min</a> - Variable in class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
<dd>
<div class="block">Minimum value.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#moduleConfigs" class="member-name-link">moduleConfigs</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Module number mapped to the JSON name.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#moduleCount" class="member-name-link">moduleCount</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Number of modules on the robot.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#moduleCount" class="member-name-link">moduleCount</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The number of swerve modules</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#%3Cinit%3E()" class="member-name-link">ModuleJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#moduleJsons" class="member-name-link">moduleJsons</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Array holding the module jsons given in <a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json"><code>SwerveDriveJson</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#moduleLocation" class="member-name-link">moduleLocation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Swerve module location relative to the robot.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#moduleLocationsMeters" class="member-name-link">moduleLocationsMeters</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Swerve Module locations.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#moduleNumber" class="member-name-link">moduleNumber</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Module number for kinematics, usually 0 to 3.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#modules" class="member-name-link">modules</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>
<div class="block">Module JSONs in order clockwise order starting from front left.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#modules" class="member-name-link">modules</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Swerve Modules.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">SparkMAX Instance.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">SparkMAX Instance.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">SparkMAX Instance.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">TalonFX motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">TalonSRX motor controller.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block">Used to store doubles for motor configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#%3Cinit%3E()" class="member-name-link">MotorConfigDouble()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
<dd>
<div class="block">Default constructor.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#%3Cinit%3E(double,double)" class="member-name-link">MotorConfigDouble(double, double)</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
<dd>
<div class="block">Default constructor.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigInt.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigInt</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block">Used to store ints for motor configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#%3Cinit%3E()" class="member-name-link">MotorConfigInt()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
<dd>
<div class="block">Default constructor.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#%3Cinit%3E(int,int)" class="member-name-link">MotorConfigInt(int, int)</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
<dd>
<div class="block">Default constructor with values.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

93
docs/index-files/index-13.html Normal file
View File

@@ -0,0 +1,93 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>N-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: N">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:N">N</h2>
<dl class="index">
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#name" class="member-name-link">name</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Name for the swerve module for telemetry.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html" class="type-name-link" title="class in swervelib.imu">NavXSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">Communicates with the NavX as the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.I2C.Port)" class="member-name-link">NavXSwerve(I2C.Port)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Constructor for the NavX swerve.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.SerialPort.Port)" class="member-name-link">NavXSwerve(SerialPort.Port)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Constructor for the NavX swerve.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.SPI.Port)" class="member-name-link">NavXSwerve(SPI.Port)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Constructor for the NavX swerve.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#nominalVoltage" class="member-name-link">nominalVoltage</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Nominal voltage default to use with feedforward.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#NONE" class="member-name-link">NONE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>
<div class="block">No telemetry data is sent back.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#normalizeAngle(double)" class="member-name-link">normalizeAngle(double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Normalize an angle to be within 0 to 360.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

113
docs/index-files/index-14.html Normal file
View File

@@ -0,0 +1,113 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>O-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: O">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:O">O</h2>
<dl class="index">
<dt><a href="../swervelib/SwerveDrive.html#odometryLock" class="member-name-link">odometryLock</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Odometry lock to ensure thread safety.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#odometryThread" class="member-name-link">odometryThread</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">WPILib <code>Notifier</code> to keep odometry up to date.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Offset for the ADIS16448.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Offset for the ADIS16470.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Offset for the ADXRS450.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Offset for the analog gyro.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Offset for the NavX.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Offset for the Pigeon 2.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Offset for the Pigeon.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#openJson(java.io.File)" class="member-name-link">openJson(File)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Open JSON file.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">The voltage to use for the smart motor voltage compensation, default is 12.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The voltage to use for the smart motor voltage compensation.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#output" class="member-name-link">output</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">The PIDF output range.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

200
docs/index-files/index-15.html Normal file
View File

@@ -0,0 +1,200 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>P-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: P">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:P">P</h2>
<dl class="index">
<dt><a href="../swervelib/parser/PIDFConfig.html#p" class="member-name-link">p</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Proportional Gain for PID.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Physical characteristics of the swerve drive from physicalproperties.json.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Physical characteristics of the swerve module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#physicalPropertiesJson" class="member-name-link">physicalPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Parsed modules/physicalproperties.json</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PhysicalPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#%3Cinit%3E()" class="member-name-link">PhysicalPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Closed-loop PID controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Closed-loop PID controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Closed-loop PID controller.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E()" class="member-name-link">PIDFConfig()</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Used when parsing PIDF values from JSON.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double)" class="member-name-link">PIDFConfig(double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double)" class="member-name-link">PIDFConfig(double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double)" class="member-name-link">PIDFConfig(double, double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double,double)" class="member-name-link">PIDFConfig(double, double, double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Parsed modules/pidfproperties.json</div>
</dd>
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#%3Cinit%3E()" class="member-name-link">PIDFPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a> - Class in <a href="../swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></dt>
<dd>
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
</dd>
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#%3Cinit%3E()" class="member-name-link">PIDFRange()</a> - Constructor for class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html" class="type-name-link" title="class in swervelib.imu">Pigeon2Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">SwerveIMU interface for the Pigeon2</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int)" class="member-name-link">Pigeon2Swerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Generate the SwerveIMU for pigeon.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int,java.lang.String)" class="member-name-link">Pigeon2Swerve(int, String)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Generate the SwerveIMU for pigeon.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html" class="type-name-link" title="class in swervelib.imu">PigeonSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">SwerveIMU interface for the Pigeon.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#%3Cinit%3E(int)" class="member-name-link">PigeonSwerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Generate the SwerveIMU for pigeon.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope(double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Put an angle within the 360 deg scope of a reference.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#PoseLog(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">PoseLog(Pose2d)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Logical inverse of the Pose exponential from 254.</div>
</dd>
<dt><a href="../swervelib/math/Matter.html#position" class="member-name-link">position</a> - Variable in class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
<dd>
<div class="block">Position in meters from robot center in 3d space.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Position" class="member-name-link">Position</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Slot 1, used for position PID's.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Position" class="member-name-link">Position</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Slot 1, used for position PID's.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#positionConversionFactor" class="member-name-link">positionConversionFactor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#postTrajectory(edu.wpi.first.math.trajectory.Trajectory)" class="member-name-link">postTrajectory(Trajectory)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Post the trajectory to the field</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Pushes the Absolute Encoder offsets to the Encoder or Motor Controller, depending on type.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Push absolute encoder offset in the memory of the encoder or controller.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
Encoder." attached via a PWM lane.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">PWMDutyCycleEncoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Constructor for the PWM duty cycle encoder.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

65
docs/index-files/index-16.html Normal file
View File

@@ -0,0 +1,65 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Q-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: Q">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:Q">Q</h2>
<dl class="index">
<dt><a href="../swervelib/SwerveModule.html#queueSynchronizeEncoders()" class="member-name-link">queueSynchronizeEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Queue synchronization of the integrated angle encoder with the absolute encoder.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

98
docs/index-files/index-17.html Normal file
View File

@@ -0,0 +1,98 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>R-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: R">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:R">R</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#rampRate" class="member-name-link">rampRate</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">The minimum number of seconds to take for the motor to go from 0 to full throttle.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#readingError" class="member-name-link">readingError</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Last angle reading was faulty.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#replaceSwerveModuleFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">replaceSwerveModuleFeedforward(SimpleMotorFeedforward)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Setup the swerve module feedforward.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#resetDriveEncoders()" class="member-name-link">resetDriveEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a reboot, like in
autonomous.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#resetOdometry(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetOdometry(Pose2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Resets odometry to the given pose.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#restoreInternalOffset()" class="member-name-link">restoreInternalOffset()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Restores Internal YAGSL Encoder offsets and sets the Encoder stored offset back to 0</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#restoreInternalOffset()" class="member-name-link">restoreInternalOffset()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Restore internal offset in YAGSL and either sets absolute encoder offset to 0 or restores old value.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#robotRotation" class="member-name-link">robotRotation</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The robot's current rotation based on odometry or gyro readings</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#rotationUnit" class="member-name-link">rotationUnit</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The units of the module rotations and robot rotation</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

765
docs/index-files/index-18.html Normal file
View File

@@ -0,0 +1,765 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>S-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: S">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:S">S</h2>
<dl class="index">
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the percentage output.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the percentage output.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the percentage output.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the percentage output.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the percentage output.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the percentage output.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Cannot Set the offset of an Analog Absolute Encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Cannot set the offset of the CanAndCoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Sets the Absolute Encoder Offset within the CANcoder's Memory.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Sets the offset of the Encoder in the WPILib Encoder Library.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Sets the Absolute Encoder Offset inside of the SparkMax's Memory.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#setAngle(double)" class="member-name-link">setAngle(double)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Set the heading of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setAngle(double)" class="member-name-link">setAngle(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the angle for the module.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setAngleMotorVoltageCompensation(double)" class="member-name-link">setAngleMotorVoltageCompensation(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set chassis speeds with closed-loop velocity control.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setDesiredState(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)" class="member-name-link">setDesiredState(SwerveModuleState, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the desired state of the swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the conversion factor for the drive motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the conversion factor for the drive motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setDriveMotorVoltageCompensation(double)" class="member-name-link">setDriveMotorVoltageCompensation(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setGyro(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyro(Rotation3d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyroOffset(Rotation3d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the gyro scope offset to a desired known rotation.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setHeadingCorrection(boolean)" class="member-name-link">setHeadingCorrection(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the heading correction capabilities of YAGSL.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#setMaximumAngularVelocity(double)" class="member-name-link">setMaximumAngularVelocity(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Set a new maximum angular velocity that is different from the auto-generated one.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> which is used for the
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double,boolean,double)" class="member-name-link">setMaximumSpeed(double, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> which is used for the
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeeds(double,double,double)" class="member-name-link">setMaximumSpeeds(double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the maximum speeds for desaturation.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setModuleStates(SwerveModuleState[], boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the module states (azimuth and velocity) directly.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the idle mode.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the idle mode.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the idle mode.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the idle mode.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the idle mode.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the idle mode.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the brake mode.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setMotorIdleMode(boolean)" class="member-name-link">setMotorIdleMode(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Sets the drive motors to brake/coast mode.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setOdometryPeriod(double)" class="member-name-link">setOdometryPeriod(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the odometry update period in seconds.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Set the gyro offset.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the integrated encoder position.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the integrated encoder position.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the integrated encoder position.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the integrated encoder position.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the integrated encoder position.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the integrated encoder position.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setRawModuleStates(SwerveModuleState[], boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the module states (azimuth and velocity) directly.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#simIMU" class="member-name-link">simIMU</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Simulation of the swerve drive.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#simModule" class="member-name-link">simModule</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Simulated swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Simulation" class="member-name-link">Simulation</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Slot 3, used arbitrarily.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Simulation" class="member-name-link">Simulation</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Slot 3, used arbitrarily.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#sizeFrontBack" class="member-name-link">sizeFrontBack</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The distance between the front and back modules.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#sizeLeftRight" class="member-name-link">sizeLeftRight</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The distance between the left and right modules.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkFlexSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block">An implementation of <code>CANSparkFlex</code> as a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">SparkFlexSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Initialize the <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> as a <code>CANSparkMax</code> connected to a Brushless Motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkFlex,boolean)" class="member-name-link">SparkFlexSwerve(CANSparkFlex, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Initialize the swerve motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a> - Enum Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block">REV Slots for PID configuration.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx()</a> - Constructor for enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx()</a> - Constructor for enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#%3Cinit%3E(swervelib.motors.SwerveMotor)" class="member-name-link">SparkMaxAnalogEncoderSwerve(SwerveMotor)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Create the <a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data
port analog pin.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block">Brushed motor control with SparkMax.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#%3Cinit%3E(int,boolean,com.revrobotics.SparkRelativeEncoder.Type,int,boolean)" class="member-name-link">SparkMaxBrushedMotorSwerve(int, boolean, SparkRelativeEncoder.Type, int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Initialize the <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> as a <code>CANSparkMax</code> connected to a Brushless Motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkMax,boolean,com.revrobotics.SparkRelativeEncoder.Type,int,boolean)" class="member-name-link">SparkMaxBrushedMotorSwerve(CANSparkMax, boolean, SparkRelativeEncoder.Type, int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Initialize the swerve motor.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#%3Cinit%3E(swervelib.motors.SwerveMotor,int)" class="member-name-link">SparkMaxEncoderSwerve(SwerveMotor, int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Create the <a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxEncoderSwerve</code></a> object as a duty cycle from the <code>CANSparkMax</code> motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">SparkMaxSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Initialize the <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> as a <code>CANSparkMax</code> connected to a Brushless Motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkMax,boolean)" class="member-name-link">SparkMaxSwerve(CANSparkMax, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Initialize the swerve motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a> - Enum Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block">REV Slots for PID configuration.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#state" class="member-name-link">state</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Current simulated swerve module state.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#stateStdDevs" class="member-name-link">stateStdDevs</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Standard deviation of encoders and gyroscopes, usually should not change.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#stopOdometryThread()" class="member-name-link">stopOdometryThread()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Stop the odometry thread in favor of manually updating odometry.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#%3Cinit%3E()" class="member-name-link">SwerveAbsoluteEncoder()</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/SwerveDrive.html#swerveController" class="member-name-link">swerveController</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve controller for controlling heading of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html" class="type-name-link" title="class in swervelib">SwerveController</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
<dd>
<div class="block">Controller class used to convert raw inputs into robot speeds.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#%3Cinit%3E(swervelib.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveController(SwerveControllerConfiguration)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot based on controller
input.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveControllerConfiguration</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<div class="block">Swerve Controller configuration class which is used to configure <a href="../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Construct the swerve controller configuration.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Construct the swerve controller configuration.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html" class="type-name-link" title="class in swervelib">SwerveDrive</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
<dd>
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.SwerveControllerConfiguration,double)" class="member-name-link">SwerveDrive(SwerveDriveConfiguration, SwerveControllerConfiguration, double)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Creates a new swerve drivebase subsystem.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#swerveDriveConfiguration" class="member-name-link">swerveDriveConfiguration</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve drive configuration.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveDriveConfiguration</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveModuleConfiguration%5B%5D,swervelib.imu.SwerveIMU,boolean,edu.wpi.first.math.controller.SimpleMotorFeedforward,swervelib.parser.SwerveModulePhysicalCharacteristics)" class="member-name-link">SwerveDriveConfiguration(SwerveModuleConfiguration[], SwerveIMU, boolean, SimpleMotorFeedforward, SwerveModulePhysicalCharacteristics)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Create swerve drive configuration.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#swerveDriveJson" class="member-name-link">swerveDriveJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Parsed swervedrive.json</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html" class="type-name-link" title="class in swervelib.parser.json">SwerveDriveJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#%3Cinit%3E()" class="member-name-link">SwerveDriveJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/SwerveDrive.html#swerveDrivePoseEstimator" class="member-name-link">swerveDrivePoseEstimator</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve odometry.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html" class="type-name-link" title="class in swervelib.telemetry">SwerveDriveTelemetry</a> - Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
<dd>
<div class="block">Telemetry to describe the <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> following frc-web-components.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#%3Cinit%3E()" class="member-name-link">SwerveDriveTelemetry()</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" class="type-name-link" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a> - Enum Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
<dd>
<div class="block">Verbosity of telemetry data sent back.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html" class="type-name-link" title="class in swervelib.imu">SwerveIMU</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#%3Cinit%3E()" class="member-name-link">SwerveIMU()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveIMUSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
<dd>
<div class="block">Simulation for <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveIMUSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Create the swerve drive IMU simulation.</div>
</dd>
<dt><a href="../swervelib/package-summary.html">swervelib</a> - package swervelib</dt>
<dd>
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
</dd>
<dt><a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a> - package swervelib.encoders</dt>
<dd>
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
</dd>
<dt><a href="../swervelib/imu/package-summary.html">swervelib.imu</a> - package swervelib.imu</dt>
<dd>
<div class="block">IMUs used for controlling the robot heading.</div>
</dd>
<dt><a href="../swervelib/math/package-summary.html">swervelib.math</a> - package swervelib.math</dt>
<dd>
<div class="block">Mathematics for swerve drives.</div>
</dd>
<dt><a href="../swervelib/motors/package-summary.html">swervelib.motors</a> - package swervelib.motors</dt>
<dd>
<div class="block">Swerve motor controller wrappers which implement <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/package-summary.html">swervelib.parser</a> - package swervelib.parser</dt>
<dd>
<div class="block">JSON Parser for YAGSL configurations.</div>
</dd>
<dt><a href="../swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a> - package swervelib.parser.deserializer</dt>
<dd>
<div class="block">Deserialize specific variables for outside the parser.</div>
</dd>
<dt><a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a> - package swervelib.parser.json</dt>
<dd>
<div class="block">JSON Mapped classes for parsing configuration files.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a> - package swervelib.parser.json.modules</dt>
<dd>
<div class="block">JSON Mapped Configuration types for modules.</div>
</dd>
<dt><a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a> - package swervelib.simulation</dt>
<dd>
<div class="block">Classes used to simulate the swerve drive.</div>
</dd>
<dt><a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a> - package swervelib.telemetry</dt>
<dd>
<div class="block">Telemetry package for sending data to NT4 or SmartDashboard.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html" class="type-name-link" title="class in swervelib.math">SwerveMath</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
<dd>
<div class="block">Mathematical functions which pertain to swerve drive.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#%3Cinit%3E()" class="member-name-link">SwerveMath()</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/SwerveModule.html" class="type-name-link" title="class in swervelib">SwerveModule</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
<dd>
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#%3Cinit%3E(int,swervelib.parser.SwerveModuleConfiguration,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">SwerveModule(int, SwerveModuleConfiguration, SimpleMotorFeedforward)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Construct the swerve module and initialize the swerve module motors and absolute encoder.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveModuleConfiguration</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<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>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, MotorConfigDouble, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, boolean, boolean, boolean, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Construct a configuration object for swerve modules.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, MotorConfigDouble, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Construct a configuration object for swerve modules.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" class="type-name-link" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(swervelib.parser.json.MotorConfigDouble,double,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(MotorConfigDouble, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Construct the swerve module physical characteristics.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(swervelib.parser.json.MotorConfigDouble,double,double,int,int,double,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(MotorConfigDouble, double, double, int, int, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Construct the swerve module physical characteristics.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#swerveModules" class="member-name-link">swerveModules</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve modules.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveModuleSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
<dd>
<div class="block">Class to hold simulation data for <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveModuleSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Create simulation class and initialize module at 0.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html" class="type-name-link" title="class in swervelib.motors">SwerveMotor</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#%3Cinit%3E()" class="member-name-link">SwerveMotor()</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/SwerveParser.html" class="type-name-link" title="class in swervelib.parser">SwerveParser</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#%3Cinit%3E(java.io.File)" class="member-name-link">SwerveParser(File)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Construct a swerve parser.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Encoder synchronization queued.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

107
docs/index-files/index-19.html Normal file
View File

@@ -0,0 +1,107 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>T-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: T">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:T">T</h2>
<dl class="index">
<dt><a href="../swervelib/motors/TalonFXSwerve.html" class="type-name-link" title="class in swervelib.motors">TalonFXSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">TalonFXSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Construct the TalonFX swerve motor given the ID.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#%3Cinit%3E(int,java.lang.String,boolean)" class="member-name-link">TalonFXSwerve(int, String, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Construct the TalonFX swerve motor given the ID and CANBus.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#%3Cinit%3E(com.ctre.phoenix6.hardware.TalonFX,boolean)" class="member-name-link">TalonFXSwerve(TalonFX, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Constructor for TalonFX swerve motor.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html" class="type-name-link" title="class in swervelib.motors">TalonSRXSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">TalonSRXSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Construct the TalonSRX swerve motor given the ID.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX,boolean)" class="member-name-link">TalonSRXSwerve(WPI_TalonSRX, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Constructor for TalonSRX swerve motor.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#%3Cinit%3E()" class="member-name-link">TelemetryVerbosity()</a> - Constructor for enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/SwerveController.html#thetaController" class="member-name-link">thetaController</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">PID Controller for the robot heading.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#timer" class="member-name-link">timer</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Main timer to control movement estimations.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#timer" class="member-name-link">timer</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Main timer to simulate the passage of time.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#type" class="member-name-link">type</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">The device type, e.g.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

91
docs/index-files/index-2.html Normal file
View File

@@ -0,0 +1,91 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>B-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: B">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:B">B</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">BoolMotorJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
<dd>
<div class="block">Inverted motor JSON parsed class.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#%3Cinit%3E()" class="member-name-link">BoolMotorJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Save the configurations from flash to EEPROM.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Save the configurations from flash to EEPROM.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Save the configurations from flash to EEPROM.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Save the configurations from flash to EEPROM.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Save the configurations from flash to EEPROM.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Save the configurations from flash to EEPROM.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

82
docs/index-files/index-20.html Normal file
View File

@@ -0,0 +1,82 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>U-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: U">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:U">U</h2>
<dl class="index">
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#updateData()" class="member-name-link">updateData()</a> - Static method in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">Upload data to smartdashboard</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#updateOdometry()" class="member-name-link">updateOdometry()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Update odometry should be run every loop.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#updateOdometry(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,edu.wpi.first.math.geometry.Pose2d%5B%5D,edu.wpi.first.wpilibj.smartdashboard.Field2d)" class="member-name-link">updateOdometry(SwerveDriveKinematics, SwerveModuleState[], Pose2d[], Field2d)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Update the odometry of the simulated <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> and post the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>
states to the <code>Field2d</code>.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#updateStateAndPosition(edu.wpi.first.math.kinematics.SwerveModuleState)" class="member-name-link">updateStateAndPosition(SwerveModuleState)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Update the position and state of the module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#updateTelemetry()" class="member-name-link">updateTelemetry()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Update data sent to <code>SmartDashboard</code>.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

110
docs/index-files/index-21.html Normal file
View File

@@ -0,0 +1,110 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>V-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: V">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:V">V</h2>
<dl class="index">
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Velocity" class="member-name-link">Velocity</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Slot 2, used for velocity PID's.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Velocity" class="member-name-link">Velocity</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>
<div class="block">Slot 2, used for velocity PID's.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#velocityPIDF" class="member-name-link">velocityPIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#verbosity" class="member-name-link">verbosity</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The current telemetry verbosity level.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The standard deviation of the vision measurement, for best accuracy calculate the standard deviation at 2 or more
points and fit a line to it and modify this using <a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,edu.wpi.first.math.Matrix)"><code>SwerveDrive.addVisionMeasurement(Pose2d, double, Matrix)</code></a>
with the calculated optimal standard deviation.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

77
docs/index-files/index-22.html Normal file
View File

@@ -0,0 +1,77 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>W-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: W">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:W">W</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#wheelGripCoefficientOfFriction" class="member-name-link">wheelGripCoefficientOfFriction</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">The grip tape coefficient of friction on carpet.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#wheelGripCoefficientOfFriction" class="member-name-link">wheelGripCoefficientOfFriction</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Wheel grip tape coefficient of friction on carpet, as described by the vendor.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#wheelLocations" class="member-name-link">wheelLocations</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The number of swerve modules</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#withinHypotDeadband(double,double)" class="member-name-link">withinHypotDeadband(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Calculate the hypot deadband and check if the joystick is within it.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

69
docs/index-files/index-23.html Normal file
View File

@@ -0,0 +1,69 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>X-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: X">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:X">X</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#x" class="member-name-link">x</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
<dd>
<div class="block">Location of the swerve module in inches from the center of the robot horizontally.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#xLimiter" class="member-name-link">xLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block"><code>SlewRateLimiter</code> for movement in the X direction in meters/second.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

69
docs/index-files/index-24.html Normal file
View File

@@ -0,0 +1,69 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Y-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: Y">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:Y">Y</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#y" class="member-name-link">y</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
<dd>
<div class="block">Location of the swerve module in inches from the center of the robot vertically.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#yLimiter" class="member-name-link">yLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block"><code>SlewRateLimiter</code> for movement in the Y direction in meters/second.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

65
docs/index-files/index-25.html Normal file
View File

@@ -0,0 +1,65 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Z-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: Z">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:Z">Z</h2>
<dl class="index">
<dt><a href="../swervelib/SwerveDrive.html#zeroGyro()" class="member-name-link">zeroGyro()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

463
docs/index-files/index-3.html Normal file
View File

@@ -0,0 +1,463 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>C-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: C">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:C">C</h2>
<dl class="index">
<dt><a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">calcMaxAccel(Rotation2d, List&lt;Matter&gt;, double, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)" class="member-name-link">calculateDegreesPerSteeringRotation(double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Calculate the degrees per steering rotation for the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#calculateMaxAcceleration(double)" class="member-name-link">calculateMaxAcceleration(double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#calculateMaxAcceleration(double,double,double,double,double)" class="member-name-link">calculateMaxAcceleration(double, double, double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Calculate the maximum theoretical acceleration without friction.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#calculateMaxAngularVelocity(double,double,double)" class="member-name-link">calculateMaxAngularVelocity(double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Calculate the maximum angular velocity.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#calculateMetersPerRotation(double,double,double)" class="member-name-link">calculateMetersPerRotation(double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Calculate the meters per rotation for the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">CanAndCoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">HELIUM <code>Canandcoder</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">CanAndCoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Create the <code>Canandcoder</code></div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#canbus" class="member-name-link">canbus</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">The CAN bus name which the device resides on if using CAN.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">CANCoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
<dd>
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">CANCoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Initialize the CANCoder on the standard CANBus.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#%3Cinit%3E(int,java.lang.String)" class="member-name-link">CANCoderSwerve(int, String)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Initialize the CANCoder on the CANivore.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#chassisVelocityCorrection" class="member-name-link">chassisVelocityCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Correct chassis velocity in <a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>SwerveDrive.drive(Translation2d, double, boolean, boolean)</code></a> using 254's
correction.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#checkDirectory(java.io.File)" class="member-name-link">checkDirectory(File)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Check directory structure.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Clear sticky faults on the encoder.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Clear sticky faults on IMU.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Clear the sticky faults on the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Clear the sticky faults on the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Clear the sticky faults on the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Clear the sticky faults on the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Clear the sticky faults on the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Clear the sticky faults on the motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#config" class="member-name-link">config</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block"><a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
robot heading, and deadband for heading joystick.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configChanged" class="member-name-link">configChanged</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">If the TalonFX configuration has changed.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Current TalonFX configuration.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Current TalonFX configuration.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Swerve module configuration options.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Configure the CANandCoder to read from [0, 360) per second.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Configure the inversion state of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configureCANStatusFrames(int)" class="member-name-link">configureCANStatusFrames(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configureCANStatusFrames(int)" class="member-name-link">configureCANStatusFrames(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#configureCANStatusFrames(int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configureCANStatusFrames(int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configureCANStatusFrames(int,int,int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configureCANStatusFrames(int,int,int,int,int,int,int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int, int, int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configureCANStatusFrames(int,int,int,int,int,int,int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int, int, int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Configure the integrated encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Configure the integrated encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Configure the integrated encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Configure the integrated encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Configure the integrated encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Configure the integrated encoder for the swerve module.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Configure the PIDF values for the closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Configure the PIDF values for the closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Configure the PIDF values for the closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Configure the PIDF values for the closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Configure the PIDF values for the closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Configure the PIDF values for the closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#configureSparkFlex(java.util.function.Supplier)" class="member-name-link">configureSparkFlex(Supplier&lt;REVLibError&gt;)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Run the configuration until it succeeds or times out.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier&lt;REVLibError&gt;)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Run the configuration until it succeeds or times out.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier&lt;REVLibError&gt;)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Run the configuration until it succeeds or times out.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier&lt;REVLibError&gt;)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Run the configuration until it succeeds or times out.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier&lt;REVLibError&gt;)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Run the configuration until it succeeds or times out.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#controllerPropertiesJson" class="member-name-link">controllerPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Parsed controllerproperties.json</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">ControllerPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#%3Cinit%3E()" class="member-name-link">ControllerPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Conversion factor for the module, if different from the one in swervedrive.json</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Conversion factor applied to the motor controllers PID loops.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The conversion factors for the drive and angle motors, created by
<a href="../swervelib/math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a> and
<a href="../swervelib/math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#conversionFactors" class="member-name-link">conversionFactors</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Conversion factor for drive motor onboard PID's and angle PID's.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#convertToNativeSensorUnits(double,double)" class="member-name-link">convertToNativeSensorUnits(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Convert the setpoint into native sensor units.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#correctionEnabled" class="member-name-link">correctionEnabled</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Whether heading correction PID is currently active.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#createControllerConfiguration(swervelib.parser.SwerveDriveConfiguration,double)" class="member-name-link">createControllerConfiguration(SwerveDriveConfiguration, double)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">Create the <a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> based on parsed and given data.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#createDriveFeedforward(double,double,double)" class="member-name-link">createDriveFeedforward(double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Create the drive feedforward for swerve modules.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#createEncoder(swervelib.motors.SwerveMotor)" class="member-name-link">createEncoder(SwerveMotor)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">Create a <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> from the current configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#createIMU()" class="member-name-link">createIMU()</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">Create a <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> from the given configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">createModuleConfiguration(PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, String)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Create the swerve module configuration based off of parsed data.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#createModules(swervelib.parser.SwerveModuleConfiguration%5B%5D,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">createModules(SwerveModuleConfiguration[], SimpleMotorFeedforward)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Create modules based off of the SwerveModuleConfiguration.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#createMotor(boolean)" class="member-name-link">createMotor(boolean)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">Create a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> from the given configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#createPhysicalProperties()" class="member-name-link">createPhysicalProperties()</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Create the physical characteristics based off the parsed data.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#createPIDController()" class="member-name-link">createPIDController()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Create a PIDController from the PID values.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(double)" class="member-name-link">createSwerveDrive(double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(double,double,double)" class="member-name-link">createSwerveDrive(double, double, double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)" class="member-name-link">createSwerveDrive(SimpleMotorFeedforward, double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)" class="member-name-link">createSwerveDrive(SimpleMotorFeedforward, double, double, double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#currentLimit" class="member-name-link">currentLimit</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">The current limit in AMPs to apply to the motors.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

151
docs/index-files/index-4.html Normal file
View File

@@ -0,0 +1,151 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>D-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: D">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:D">D</h2>
<dl class="index">
<dt><a href="../swervelib/parser/PIDFConfig.html#d" class="member-name-link">d</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Derivative Gain for PID.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#desiredChassisSpeeds" class="member-name-link">desiredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">Describes the desired forward, sideways and angular velocity of the robot.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#desiredStates" class="member-name-link">desiredStates</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">An array of rotation and velocity values describing the desired state of each swerve module</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html" class="type-name-link" title="class in swervelib.parser.json">DeviceJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block">Device JSON parsed class.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#%3Cinit%3E()" class="member-name-link">DeviceJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Drive motor device configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
<dd>
<div class="block">Drive motor inversion state.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
<dd>
<div class="block">Drive motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
<dd>
<div class="block">Drive motor.</div>
</dd>
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dd>
<div class="block">The PIDF with Integral Zone used for the drive motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)" class="member-name-link">drive(Translation2d, double, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The primary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">drive(Translation2d, double, boolean, boolean, Translation2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The primary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">drive(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Secondary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.kinematics.ChassisSpeeds,boolean,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">drive(ChassisSpeeds, boolean, Translation2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The primary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">drive(ChassisSpeeds, Translation2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Secondary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">driveFieldOriented(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Secondary method of controlling the drive base given velocity and adjusting it for field oriented use.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">driveFieldOriented(ChassisSpeeds, Translation2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Secondary method of controlling the drive base given velocity and adjusting it for field oriented use.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The drive motor and angle motor of this swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Swerve Motors.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorCurrentLimit" class="member-name-link">driveMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Current limits for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotorInverted" class="member-name-link">driveMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">State of inversion of the drive motor.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorRampRate" class="member-name-link">driveMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#dt" class="member-name-link">dt</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Time delta since last update</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

101
docs/index-files/index-5.html Normal file
View File

@@ -0,0 +1,101 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>E-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: E">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:E">E</h2>
<dl class="index">
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Encoder as Analog Input.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">CANCoder with WPILib sendable and support.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Duty Cycle Encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">The <code>SparkAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Integrated encoder.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Absolute encoder device configuration.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

193
docs/index-files/index-6.html Normal file
View File

@@ -0,0 +1,193 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>F-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: F">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:F">F</h2>
<dl class="index">
<dt><a href="../swervelib/parser/PIDFConfig.html#f" class="member-name-link">f</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Feedforward value for PID.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Reset the encoder to factory defaults.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Reset IMU to factory default.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Factory default already occurred.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Factory default already occurred.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Factory default already occurred.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Factory default already occurred.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Factory default already occurred.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#fakePos" class="member-name-link">fakePos</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Fake motor position.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#fakeSpeed" class="member-name-link">fakeSpeed</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">The fake speed of the previous state, used to calculate <a href="../swervelib/simulation/SwerveModuleSimulation.html#fakePos"><code>SwerveModuleSimulation.fakePos</code></a>.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#feedforward" class="member-name-link">feedforward</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Feedforward for drive motor during closed loop control.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#field" class="member-name-link">field</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Field object.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#forwardDirection" class="member-name-link">forwardDirection</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The direction the robot should be facing when the "Robot Rotation" is zero or blank.</div>
</dd>
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#front" class="member-name-link">front</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
<dd>
<div class="block">Location of the swerve module in inches from the center of the robot horizontally.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

503
docs/index-files/index-7.html Normal file
View File

@@ -0,0 +1,503 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>G-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: G">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:G">G</h2>
<dl class="index">
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Get the encoder object.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Get the instantiated absolute encoder Object.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getAbsoluteEncoderReadIssue()" class="member-name-link">getAbsoluteEncoderReadIssue()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get if the last Absolute Encoder had a read issue, such as it does not exist.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Get the absolute position of the encoder.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the absolute position.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Fetch the acceleration [x, y, z] from the IMU in m/s/s.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets current acceleration of the robot in m/s/s.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getAngleMotor()" class="member-name-link">getAngleMotor()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the angle <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getConfiguration()" class="member-name-link">getConfiguration()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Fetch the <a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed configurations.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#getDriveBaseRadiusMeters()" class="member-name-link">getDriveBaseRadiusMeters()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Assume the first module is the furthest.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getDriveMotor()" class="member-name-link">getDriveMotor()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the drive <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getFieldVelocity()" class="member-name-link">getFieldVelocity()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current field-relative velocity (x, y and omega) of the robot</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getGyroRotation3d()" class="member-name-link">getGyroRotation3d()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Gets the estimated gyro <code>Rotation3d</code> of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getGyroRotation3d()" class="member-name-link">getGyroRotation3d()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current gyro <code>Rotation3d</code> of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getJoystickAngle(double,double)" class="member-name-link">getJoystickAngle(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the angle in radians based off of the heading joysticks.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName(String, SwerveDriveConfiguration)</a> - Static method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Get the swerve module by the json name.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getModulePositions()" class="member-name-link">getModulePositions()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current module positions (azimuth and wheel position (meters)).</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getModules()" class="member-name-link">getModules()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Get the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>s associated with the <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getPitch()" class="member-name-link">getPitch()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Pitch is not simulated currently, always returns 0.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getPitch()" class="member-name-link">getPitch()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current pitch angle of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getPose()" class="member-name-link">getPose()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current pose (position and rotation) of the robot, as reported by odometry.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Get the position of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Get the position of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Get the position of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Get the position of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Get the position of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Get the position of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Get the simulated swerve module position.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the position of the swerve module.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getRawTargetSpeeds(double,double,double)" class="member-name-link">getRawTargetSpeeds(double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getRawTargetSpeeds(double,double,double,double)" class="member-name-link">getRawTargetSpeeds(double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getRelativePosition()" class="member-name-link">getRelativePosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the relative angle in degrees.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getRobotVelocity()" class="member-name-link">getRobotVelocity()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current robot-relative velocity (x, y and omega) of the robot</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getRoll()" class="member-name-link">getRoll()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Roll is not simulated currently, always returns 0.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getRoll()" class="member-name-link">getRoll()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current roll angle of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/SwerveIMU.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
<dd>
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#getState()" class="member-name-link">getState()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Get the <code>SwerveModuleState</code> of the simulated module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getState()" class="member-name-link">getState()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the Swerve Module state.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getStates()" class="member-name-link">getStates()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current module states (azimuth and velocity)</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getSwerveController()" class="member-name-link">getSwerveController()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Helper function to get the <a href="../swervelib/SwerveDrive.html#swerveController"><code>SwerveDrive.swerveController</code></a> for the <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> which can be used to
generate <code>ChassisSpeeds</code> for the robot to orient it correctly given axis or angles, and apply
<code>SlewRateLimiter</code> to given inputs.</div>
</dd>
<dt><a href="../swervelib/math/SwerveMath.html#getSwerveModule(swervelib.SwerveModule%5B%5D,boolean,boolean)" class="member-name-link">getSwerveModule(SwerveModule[], boolean, boolean)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Get the fruthest module from center based on the module locations.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getSwerveModulePoses(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">getSwerveModulePoses(Pose2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Get the swerve module poses and on the field relative to the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTranslation2d(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">getTranslation2d(ChassisSpeeds)</a> - Static method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Helper function to get the <code>Translation2d</code> of the chassis speeds given the <code>ChassisSpeeds</code>.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
<dd>
<div class="block">Get the velocity in degrees/sec.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Get the estimated angle of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Gyroscope object.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">NavX IMU.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

85
docs/index-files/index-8.html Normal file
View File

@@ -0,0 +1,85 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>H-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: H">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:H">H</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#heading" class="member-name-link">heading</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">The PID used to control the robot heading.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#HEADING_CORRECTION_DEADBAND" class="member-name-link">HEADING_CORRECTION_DEADBAND</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Deadband for speeds in heading correction.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#headingCalculate(double,double)" class="member-name-link">headingCalculate(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Calculate the angular velocity given the current and target heading angle in radians.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#headingCorrection" class="member-name-link">headingCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Whether to correct heading when driving translationally.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#headingPIDF" class="member-name-link">headingPIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">PIDF for the heading of the robot.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#HIGH" class="member-name-link">HIGH</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
<dd>
<div class="block">Full swerve drive data is sent back in both human and machine readable forms.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

165
docs/index-files/index-9.html Normal file
View File

@@ -0,0 +1,165 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>I-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index: I">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head>
<body class="index-page">
<script type="text/javascript">var pathtoroot = "../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="../help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1>Index</h1>
</div>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:I">I</h2>
<dl class="index">
<dt><a href="../swervelib/parser/PIDFConfig.html#i" class="member-name-link">i</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Integral Gain for PID.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#id" class="member-name-link">id</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">The CAN ID or pin ID of the device.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
</dd>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Pigeon2 IMU device.</div>
</dd>
<dt><a href="../swervelib/imu/PigeonSwerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Pigeon v1 IMU device.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>
<div class="block">Robot IMU used to determine heading of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Swerve IMU</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Inversion state of the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
<dd>
<div class="block">Inversion state of the encoder.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Defines which motors are inverted.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>
<div class="block">Invert the IMU of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Invert the imu measurements.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#invertOdometry" class="member-name-link">invertOdometry</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Invert odometry readings of drive motor positions, used as a patch for debugging currently.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><a href="../swervelib/motors/SwerveMotor.html#isDriveMotor" class="member-name-link">isDriveMotor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Whether the swerve motor is a drive motor.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#isInverted" class="member-name-link">isInverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">Inversion state.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#isSimulation" class="member-name-link">isSimulation</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">State of simulation of the Robot, used to optimize retrieval.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#iz" class="member-name-link">iz</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Integral zone of the PID.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>
</div>
</body>
</html>

20
docs/index.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Overview (YAGSL-Example API)</title> <title>Overview</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="package index"> <meta name="description" content="package index">
<meta name="generator" content="javadoc/PackageIndexWriter"> <meta name="generator" content="javadoc/PackageIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script> <script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-index-page"> <body class="package-index-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li>Package</li> <li>Package</li>
<li>Class</li> <li>Class</li>
<li><a href="overview-tree.html">Tree</a></li> <li><a href="overview-tree.html">Tree</a></li>
<li><a href="index-all.html">Index</a></li> <li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html#overview">Help</a></li> <li><a href="help-doc.html#overview">Help</a></li>
</ul> </ul>
</div> </div>
@@ -46,22 +47,11 @@ loadScripts(document, 'script');</script>
</header> </header>
<div class="flex-content"> <div class="flex-content">
<main role="main"> <main role="main">
<div class="header">
<h1 class="title">YAGSL-Example API</h1>
</div>
<div id="all-packages-table"> <div id="all-packages-table">
<div class="caption"><span>Packages</span></div> <div class="caption"><span>Packages</span></div>
<div class="summary-table two-column-summary"> <div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div> <div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div> <div class="table-header col-last">Description</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="frc/robot/package-summary.html">frc.robot</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="frc/robot/commands/swervedrive/auto/package-summary.html">frc.robot.commands.swervedrive.auto</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="frc/robot/commands/swervedrive/drivebase/package-summary.html">frc.robot.commands.swervedrive.drivebase</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="frc/robot/subsystems/swervedrive/package-summary.html">frc.robot.subsystems.swervedrive</a></div>
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">&nbsp;</div>
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/package-summary.html">swervelib</a></div> <div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/package-summary.html">swervelib</a></div>
<div class="col-last even-row-color all-packages-table all-packages-table-tab1"> <div class="col-last even-row-color all-packages-table all-packages-table-tab1">
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div> <div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>

3
docs/jquery-ui.overrides.css vendored
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@@ -31,5 +31,4 @@ a.ui-button:active,
.ui-button.ui-state-active:hover { .ui-button.ui-state-active:hover {
/* Overrides the color of selection used in jQuery UI */ /* Overrides the color of selection used in jQuery UI */
background: #F8981D; background: #F8981D;
border: 1px solid #F8981D;
} }

8
docs/legal/jquery.md
View File

@@ -1,9 +1,9 @@
## jQuery v3.6.0 ## jQuery v3.5.1
### jQuery License ### jQuery License
``` ```
jQuery v 3.6.0 jQuery v 3.5.1
Copyright OpenJS Foundation and other contributors, https://openjsf.org/ Copyright JS Foundation and other contributors, https://js.foundation/
Permission is hereby granted, free of charge, to any person obtaining Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the a copy of this software and associated documentation files (the
@@ -26,7 +26,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************** ******************************************
The jQuery JavaScript Library v3.6.0 also includes Sizzle.js The jQuery JavaScript Library v3.5.1 also includes Sizzle.js
Sizzle.js includes the following license: Sizzle.js includes the following license:

2
docs/member-search-index.js
View File

File diff suppressed because one or more lines are too long

5
docs/overview-summary.html
View File

@@ -1,10 +1,11 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>YAGSL-Example API</title> <title>Generated Documentation (Untitled)</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="index redirect"> <meta name="description" content="index redirect">
<meta name="generator" content="javadoc/IndexRedirectWriter"> <meta name="generator" content="javadoc/IndexRedirectWriter">
<link rel="canonical" href="index.html"> <link rel="canonical" href="index.html">

48
docs/overview-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Class Hierarchy (YAGSL-Example API)</title> <title>Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="class tree"> <meta name="description" content="class tree">
<meta name="generator" content="javadoc/TreeWriter"> <meta name="generator" content="javadoc/TreeWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="script.js"></script> <script type="text/javascript" src="script.js"></script>
<script type="text/javascript" src="script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="tree-page"> <body class="tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li>Package</li> <li>Package</li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="index-all.html">Index</a></li> <li><a href="index-files/index-1.html">Index</a></li>
<li><a href="help-doc.html#tree">Help</a></li> <li><a href="help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>
@@ -50,10 +51,6 @@ loadScripts(document, 'script');</script>
<h1 class="title">Hierarchy For All Packages</h1> <h1 class="title">Hierarchy For All Packages</h1>
<span class="package-hierarchy-label">Package Hierarchies:</span> <span class="package-hierarchy-label">Package Hierarchies:</span>
<ul class="horizontal"> <ul class="horizontal">
<li><a href="frc/robot/package-tree.html">frc.robot</a>, </li>
<li><a href="frc/robot/commands/swervedrive/auto/package-tree.html">frc.robot.commands.swervedrive.auto</a>, </li>
<li><a href="frc/robot/commands/swervedrive/drivebase/package-tree.html">frc.robot.commands.swervedrive.drivebase</a>, </li>
<li><a href="frc/robot/subsystems/swervedrive/package-tree.html">frc.robot.subsystems.swervedrive</a>, </li>
<li><a href="swervelib/package-tree.html">swervelib</a>, </li> <li><a href="swervelib/package-tree.html">swervelib</a>, </li>
<li><a href="swervelib/encoders/package-tree.html">swervelib.encoders</a>, </li> <li><a href="swervelib/encoders/package-tree.html">swervelib.encoders</a>, </li>
<li><a href="swervelib/imu/package-tree.html">swervelib.imu</a>, </li> <li><a href="swervelib/imu/package-tree.html">swervelib.imu</a>, </li>
@@ -73,23 +70,9 @@ loadScripts(document, 'script');</script>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a> <li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
<ul> <ul>
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/BoolMotorJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">BoolMotorJson</a></li> <li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/BoolMotorJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">BoolMotorJson</a></li>
<li class="circle">edu.wpi.first.wpilibj2.command.Command (implements edu.wpi.first.util.sendable.Sendable)
<ul>
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="frc/robot/commands/swervedrive/drivebase/AbsoluteDrive.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDrive</a></li>
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="frc/robot/commands/swervedrive/drivebase/AbsoluteDriveAdv.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDriveAdv</a></li>
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="frc/robot/commands/swervedrive/drivebase/AbsoluteFieldDrive.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteFieldDrive</a></li>
<li class="circle">frc.robot.commands.swervedrive.auto.<a href="frc/robot/commands/swervedrive/auto/AutoBalanceCommand.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.auto">AutoBalanceCommand</a></li>
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="frc/robot/commands/swervedrive/drivebase/TeleopDrive.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">TeleopDrive</a></li>
</ul>
</li>
<li class="circle">frc.robot.<a href="frc/robot/Constants.html" class="type-name-link" title="class in frc.robot">Constants</a></li>
<li class="circle">frc.robot.<a href="frc/robot/Constants.Auton.html" class="type-name-link" title="class in frc.robot">Constants.Auton</a></li>
<li class="circle">frc.robot.<a href="frc/robot/Constants.Drivebase.html" class="type-name-link" title="class in frc.robot">Constants.Drivebase</a></li>
<li class="circle">frc.robot.<a href="frc/robot/Constants.OperatorConstants.html" class="type-name-link" title="class in frc.robot">Constants.OperatorConstants</a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ControllerPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">ControllerPropertiesJson</a></li> <li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ControllerPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">ControllerPropertiesJson</a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/DeviceJson.html" class="type-name-link" title="class in swervelib.parser.json">DeviceJson</a></li> <li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/DeviceJson.html" class="type-name-link" title="class in swervelib.parser.json">DeviceJson</a></li>
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a></li> <li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a></li>
<li class="circle">frc.robot.<a href="frc/robot/Main.html" class="type-name-link" title="class in frc.robot">Main</a></li>
<li class="circle">swervelib.math.<a href="swervelib/math/Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a></li> <li class="circle">swervelib.math.<a href="swervelib/math/Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a></li> <li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a></li> <li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a></li>
@@ -98,25 +81,6 @@ loadScripts(document, 'script');</script>
<li class="circle">swervelib.parser.<a href="swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a></li> <li class="circle">swervelib.parser.<a href="swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a></li>
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a></li> <li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a></li>
<li class="circle">swervelib.parser.deserializer.<a href="swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a></li> <li class="circle">swervelib.parser.deserializer.<a href="swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a></li>
<li class="circle">edu.wpi.first.wpilibj.RobotBase (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a>)
<ul>
<li class="circle">edu.wpi.first.wpilibj.IterativeRobotBase
<ul>
<li class="circle">edu.wpi.first.wpilibj.TimedRobot
<ul>
<li class="circle">frc.robot.<a href="frc/robot/Robot.html" class="type-name-link" title="class in frc.robot">Robot</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="circle">frc.robot.<a href="frc/robot/RobotContainer.html" class="type-name-link" title="class in frc.robot">RobotContainer</a></li>
<li class="circle">edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem)
<ul>
<li class="circle">frc.robot.subsystems.swervedrive.<a href="frc/robot/subsystems/swervedrive/SwerveSubsystem.html" class="type-name-link" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a></li>
</ul>
</li>
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> <li class="circle">swervelib.encoders.<a href="swervelib/encoders/SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>
<ul> <ul>
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></li> <li class="circle">swervelib.encoders.<a href="swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></li>
@@ -171,6 +135,8 @@ loadScripts(document, 'script');</script>
<ul> <ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a>&lt;E&gt; (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;T&gt;, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>) <li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a>&lt;E&gt; (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;T&gt;, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
<ul> <ul>
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></li>
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></li>
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" class="type-name-link" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></li> <li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" class="type-name-link" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></li>
</ul> </ul>
</li> </li>

2
docs/package-search-index.js
View File

@@ -1 +1 @@
packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"frc.robot"},{"l":"frc.robot.commands.swervedrive.auto"},{"l":"frc.robot.commands.swervedrive.drivebase"},{"l":"frc.robot.subsystems.swervedrive"},{"l":"swervelib"},{"l":"swervelib.encoders"},{"l":"swervelib.imu"},{"l":"swervelib.math"},{"l":"swervelib.motors"},{"l":"swervelib.parser"},{"l":"swervelib.parser.deserializer"},{"l":"swervelib.parser.json"},{"l":"swervelib.parser.json.modules"},{"l":"swervelib.simulation"},{"l":"swervelib.telemetry"}];updateSearchResults(); packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"swervelib"},{"l":"swervelib.encoders"},{"l":"swervelib.imu"},{"l":"swervelib.math"},{"l":"swervelib.motors"},{"l":"swervelib.parser"},{"l":"swervelib.parser.deserializer"},{"l":"swervelib.parser.json"},{"l":"swervelib.parser.json.modules"},{"l":"swervelib.simulation"},{"l":"swervelib.telemetry"}];updateSearchResults();

BIN
docs/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 335 B

BIN
docs/script-dir/images/ui-bg_glass_65_dadada_1x400.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 262 B

BIN
docs/script-dir/images/ui-bg_glass_75_dadada_1x400.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 262 B

BIN
docs/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 262 B

BIN
docs/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 332 B

BIN
docs/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 280 B

BIN
docs/script-dir/images/ui-icons_222222_256x240.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.8 KiB

BIN
docs/script-dir/images/ui-icons_2e83ff_256x240.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

BIN
docs/script-dir/images/ui-icons_454545_256x240.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.8 KiB

BIN
docs/script-dir/images/ui-icons_888888_256x240.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.8 KiB

BIN
docs/script-dir/images/ui-icons_cd0a0a_256x240.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.4 KiB

2
docs/script-dir/jquery-3.5.1.min.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

7
docs/script-dir/jquery-ui.min.css vendored
View File

File diff suppressed because one or more lines are too long

4
docs/script-dir/jquery-ui.min.js vendored
View File

File diff suppressed because one or more lines are too long

5
docs/script-dir/jquery-ui.structure.min.css vendored Normal file
View File

@@ -0,0 +1,5 @@
/*! jQuery UI - v1.12.1 - 2018-12-06
* http://jqueryui.com
* Copyright jQuery Foundation and other contributors; Licensed MIT */
.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;filter:Alpha(Opacity=0)}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0}

4
docs/stylesheet.css
View File

@@ -611,7 +611,6 @@ main, nav, header, footer, section {
ul.ui-autocomplete { ul.ui-autocomplete {
position:fixed; position:fixed;
z-index:999999; z-index:999999;
background-color: #FFFFFF;
} }
ul.ui-autocomplete li { ul.ui-autocomplete li {
float:left; float:left;
@@ -621,9 +620,6 @@ ul.ui-autocomplete li {
.result-highlight { .result-highlight {
font-weight:bold; font-weight:bold;
} }
.ui-autocomplete .result-item {
font-size: inherit;
}
#search-input { #search-input {
background-image:url('resources/glass.png'); background-image:url('resources/glass.png');
background-size:13px; background-size:13px;

9
docs/swervelib/SwerveController.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveController (YAGSL-Example API)</title> <title>SwerveController</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib, class: SwerveController"> <meta name="description" content="declaration: package: swervelib, class: SwerveController">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script> <script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li> <li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html#class">Help</a></li> <li><a href="../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

258
docs/swervelib/SwerveDrive.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveDrive (YAGSL-Example API)</title> <title>SwerveDrive</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib, class: SwerveDrive"> <meta name="description" content="declaration: package: swervelib, class: SwerveDrive">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script> <script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li> <li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html#class">Help</a></li> <li><a href="../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -90,52 +91,112 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div> <div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div> <div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div> <div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private double</code></div>
<div class="col-second even-row-color"><code><a href="#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a></code></div>
<div class="col-last even-row-color">
<div class="block">The absolute max speed the robot can reach while rotating radians per second.</div>
</div>
<div class="col-first odd-row-color"><code>private double</code></div>
<div class="col-second odd-row-color"><code><a href="#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The absolute max speed that your robot can reach while translating in meters per second.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div> <div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#chassisVelocityCorrection" class="member-name-link">chassisVelocityCorrection</a></code></div> <div class="col-second even-row-color"><code><a href="#chassisVelocityCorrection" class="member-name-link">chassisVelocityCorrection</a></code></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Correct chassis velocity in <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(Translation2d, double, boolean, boolean)</code></a> using 254's <div class="block">Correct chassis velocity in <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(Translation2d, double, boolean, boolean)</code></a> using 254's
correction.</div> correction.</div>
</div> </div>
<div class="col-first odd-row-color"><code>edu.wpi.first.wpilibj.smartdashboard.Field2d</code></div> <div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#field" class="member-name-link">field</a></code></div> <div class="col-second odd-row-color"><code><a href="#correctionEnabled" class="member-name-link">correctionEnabled</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Whether heading correction PID is currently active.</div>
</div>
<div class="col-first even-row-color"><code>edu.wpi.first.wpilibj.smartdashboard.Field2d</code></div>
<div class="col-second even-row-color"><code><a href="#field" class="member-name-link">field</a></code></div>
<div class="col-last even-row-color">
<div class="block">Field object.</div> <div class="block">Field object.</div>
</div> </div>
<div class="col-first odd-row-color"><code>private final double</code></div>
<div class="col-second odd-row-color"><code><a href="#HEADING_CORRECTION_DEADBAND" class="member-name-link">HEADING_CORRECTION_DEADBAND</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Deadband for speeds in heading correction.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div> <div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#headingCorrection" class="member-name-link">headingCorrection</a></code></div> <div class="col-second even-row-color"><code><a href="#headingCorrection" class="member-name-link">headingCorrection</a></code></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Whether to correct heading when driving translationally.</div> <div class="block">Whether to correct heading when driving translationally.</div>
</div> </div>
<div class="col-first odd-row-color"><code>boolean</code></div> <div class="col-first odd-row-color"><code>private <a href="imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></div>
<div class="col-second odd-row-color"><code><a href="#invertOdometry" class="member-name-link">invertOdometry</a></code></div> <div class="col-second odd-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#invertOdometry" class="member-name-link">invertOdometry</a></code></div>
<div class="col-last even-row-color">
<div class="block">Invert odometry readings of drive motor positions, used as a patch for debugging currently.</div> <div class="block">Invert odometry readings of drive motor positions, used as a patch for debugging currently.</div>
</div> </div>
<div class="col-first even-row-color"><code>final edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div> <div class="col-first odd-row-color"><code>final edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div>
<div class="col-second even-row-color"><code><a href="#kinematics" class="member-name-link">kinematics</a></code></div> <div class="col-second odd-row-color"><code><a href="#kinematics" class="member-name-link">kinematics</a></code></div>
<div class="col-last even-row-color"> <div class="col-last odd-row-color">
<div class="block">Swerve Kinematics object.</div> <div class="block">Swerve Kinematics object.</div>
</div> </div>
<div class="col-first odd-row-color"><code>edu.wpi.first.math.Matrix&lt;edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1&gt;</code></div> <div class="col-first even-row-color"><code>private double</code></div>
<div class="col-second odd-row-color"><code><a href="#stateStdDevs" class="member-name-link">stateStdDevs</a></code></div> <div class="col-second even-row-color"><code><a href="#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a></code></div>
<div class="col-last even-row-color">
<div class="block">The last heading set in radians.</div>
</div>
<div class="col-first odd-row-color"><code>private double</code></div>
<div class="col-second odd-row-color"><code><a href="#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Maximum speed of the robot in meters per second.</div>
</div>
<div class="col-first even-row-color"><code>private int</code></div>
<div class="col-second even-row-color"><code><a href="#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a></code></div>
<div class="col-last even-row-color">
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
</div>
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks" class="external-link">Lock</a></code></div>
<div class="col-second odd-row-color"><code><a href="#odometryLock" class="member-name-link">odometryLock</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Odometry lock to ensure thread safety.</div>
</div>
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.Notifier</code></div>
<div class="col-second even-row-color"><code><a href="#odometryThread" class="member-name-link">odometryThread</a></code></div>
<div class="col-last even-row-color">
<div class="block">WPILib <code>Notifier</code> to keep odometry up to date.</div>
</div>
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></code></div>
<div class="col-second odd-row-color"><code><a href="#simIMU" class="member-name-link">simIMU</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Simulation of the swerve drive.</div>
</div>
<div class="col-first even-row-color"><code>edu.wpi.first.math.Matrix&lt;edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1&gt;</code></div>
<div class="col-second even-row-color"><code><a href="#stateStdDevs" class="member-name-link">stateStdDevs</a></code></div>
<div class="col-last even-row-color">
<div class="block">Standard deviation of encoders and gyroscopes, usually should not change.</div> <div class="block">Standard deviation of encoders and gyroscopes, usually should not change.</div>
</div> </div>
<div class="col-first even-row-color"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div> <div class="col-first odd-row-color"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
<div class="col-second even-row-color"><code><a href="#swerveController" class="member-name-link">swerveController</a></code></div> <div class="col-second odd-row-color"><code><a href="#swerveController" class="member-name-link">swerveController</a></code></div>
<div class="col-last even-row-color"> <div class="col-last odd-row-color">
<div class="block">Swerve controller for controlling heading of the robot.</div> <div class="block">Swerve controller for controlling heading of the robot.</div>
</div> </div>
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></code></div> <div class="col-first even-row-color"><code>final <a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></code></div>
<div class="col-second odd-row-color"><code><a href="#swerveDriveConfiguration" class="member-name-link">swerveDriveConfiguration</a></code></div> <div class="col-second even-row-color"><code><a href="#swerveDriveConfiguration" class="member-name-link">swerveDriveConfiguration</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last even-row-color">
<div class="block">Swerve drive configuration.</div> <div class="block">Swerve drive configuration.</div>
</div> </div>
<div class="col-first even-row-color"><code>final edu.wpi.first.math.estimator.SwerveDrivePoseEstimator</code></div> <div class="col-first odd-row-color"><code>final edu.wpi.first.math.estimator.SwerveDrivePoseEstimator</code></div>
<div class="col-second even-row-color"><code><a href="#swerveDrivePoseEstimator" class="member-name-link">swerveDrivePoseEstimator</a></code></div> <div class="col-second odd-row-color"><code><a href="#swerveDrivePoseEstimator" class="member-name-link">swerveDrivePoseEstimator</a></code></div>
<div class="col-last even-row-color"> <div class="col-last odd-row-color">
<div class="block">Swerve odometry.</div> <div class="block">Swerve odometry.</div>
</div> </div>
<div class="col-first even-row-color"><code>private final <a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
<div class="col-second even-row-color"><code><a href="#swerveModules" class="member-name-link">swerveModules</a></code></div>
<div class="col-last even-row-color">
<div class="block">Swerve modules.</div>
</div>
<div class="col-first odd-row-color"><code>edu.wpi.first.math.Matrix&lt;edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1&gt;</code></div> <div class="col-first odd-row-color"><code>edu.wpi.first.math.Matrix&lt;edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a></code></div> <div class="col-second odd-row-color"><code><a href="#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
@@ -371,8 +432,8 @@ loadScripts(document, 'script');</script>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed</a><wbr>(double&nbsp;maximumSpeed)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed</a><wbr>(double&nbsp;maximumSpeed)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the maximum speed of the drive motors, modified <code>maxSpeedMPS</code> which is used for the <div class="block">Set the maximum speed of the drive motors, modified <a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> which is used for the
<code>setRawModuleStates(SwerveModuleState[], boolean)</code> function and <a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div> <a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
@@ -380,8 +441,8 @@ loadScripts(document, 'script');</script>
boolean&nbsp;updateModuleFeedforward, boolean&nbsp;updateModuleFeedforward,
double&nbsp;optimalVoltage)</code></div> double&nbsp;optimalVoltage)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the maximum speed of the drive motors, modified <code>maxSpeedMPS</code> which is used for the <div class="block">Set the maximum speed of the drive motors, modified <a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> which is used for the
<code>setRawModuleStates(SwerveModuleState[], boolean)</code> function and <a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div> <a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
@@ -407,24 +468,30 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the odometry update period in seconds.</div> <div class="block">Set the odometry update period in seconds.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopOdometryThread()" class="member-name-link">stopOdometryThread</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setRawModuleStates</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState[]&nbsp;desiredStates,
boolean&nbsp;isOpenLoop)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the module states (azimuth and velocity) directly.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopOdometryThread()" class="member-name-link">stopOdometryThread</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Stop the odometry thread in favor of manually updating odometry.</div> <div class="block">Stop the odometry thread in favor of manually updating odometry.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div> <div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateOdometry()" class="member-name-link">updateOdometry</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateOdometry()" class="member-name-link">updateOdometry</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Update odometry should be run every loop.</div> <div class="block">Update odometry should be run every loop.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zeroGyro()" class="member-name-link">zeroGyro</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zeroGyro()" class="member-name-link">zeroGyro</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div> <div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
</div> </div>
</div> </div>
@@ -466,6 +533,27 @@ loadScripts(document, 'script');</script>
</section> </section>
</li> </li>
<li> <li>
<section class="detail" id="swerveModules">
<h3>swerveModules</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</span>&nbsp;<span class="element-name">swerveModules</span></div>
<div class="block">Swerve modules.</div>
</section>
</li>
<li>
<section class="detail" id="odometryThread">
<h3>odometryThread</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.Notifier</span>&nbsp;<span class="element-name">odometryThread</span></div>
<div class="block">WPILib <code>Notifier</code> to keep odometry up to date.</div>
</section>
</li>
<li>
<section class="detail" id="odometryLock">
<h3>odometryLock</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks" class="external-link">Lock</a></span>&nbsp;<span class="element-name">odometryLock</span></div>
<div class="block">Odometry lock to ensure thread safety.</div>
</section>
</li>
<li>
<section class="detail" id="field"> <section class="detail" id="field">
<h3>field</h3> <h3>field</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.smartdashboard.Field2d</span>&nbsp;<span class="element-name">field</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.smartdashboard.Field2d</span>&nbsp;<span class="element-name">field</span></div>
@@ -513,12 +601,83 @@ loadScripts(document, 'script');</script>
</section> </section>
</li> </li>
<li> <li>
<section class="detail" id="correctionEnabled">
<h3>correctionEnabled</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">correctionEnabled</span></div>
<div class="block">Whether heading correction PID is currently active.</div>
</section>
</li>
<li>
<section class="detail" id="headingCorrection"> <section class="detail" id="headingCorrection">
<h3>headingCorrection</h3> <h3>headingCorrection</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">headingCorrection</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">headingCorrection</span></div>
<div class="block">Whether to correct heading when driving translationally. Set to true to enable.</div> <div class="block">Whether to correct heading when driving translationally. Set to true to enable.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></span>&nbsp;<span class="element-name">imu</span></div>
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
</section>
</li>
<li>
<section class="detail" id="simIMU">
<h3>simIMU</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></span>&nbsp;<span class="element-name">simIMU</span></div>
<div class="block">Simulation of the swerve drive.</div>
</section>
</li>
<li>
<section class="detail" id="moduleSynchronizationCounter">
<h3>moduleSynchronizationCounter</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">moduleSynchronizationCounter</span></div>
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
</section>
</li>
<li>
<section class="detail" id="HEADING_CORRECTION_DEADBAND">
<h3>HEADING_CORRECTION_DEADBAND</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">HEADING_CORRECTION_DEADBAND</span></div>
<div class="block">Deadband for speeds in heading correction.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../constant-values.html#swervelib.SwerveDrive.HEADING_CORRECTION_DEADBAND">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="lastHeadingRadians">
<h3>lastHeadingRadians</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">lastHeadingRadians</span></div>
<div class="block">The last heading set in radians.</div>
</section>
</li>
<li>
<section class="detail" id="attainableMaxTranslationalSpeedMetersPerSecond">
<h3>attainableMaxTranslationalSpeedMetersPerSecond</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">attainableMaxTranslationalSpeedMetersPerSecond</span></div>
<div class="block">The absolute max speed that your robot can reach while translating in meters per second.</div>
</section>
</li>
<li>
<section class="detail" id="attainableMaxRotationalVelocityRadiansPerSecond">
<h3>attainableMaxRotationalVelocityRadiansPerSecond</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">attainableMaxRotationalVelocityRadiansPerSecond</span></div>
<div class="block">The absolute max speed the robot can reach while rotating radians per second.</div>
</section>
</li>
<li>
<section class="detail" id="maxSpeedMPS">
<h3>maxSpeedMPS</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">maxSpeedMPS</span></div>
<div class="block">Maximum speed of the robot in meters per second.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>
@@ -534,9 +693,9 @@ loadScripts(document, 'script');</script>
<a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a>&nbsp;controllerConfig, <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a>&nbsp;controllerConfig,
double&nbsp;maxSpeedMPS)</span></div> double&nbsp;maxSpeedMPS)</span></div>
<div class="block">Creates a new swerve drivebase subsystem. Robot is controlled via the <a href="#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)"><code>drive(edu.wpi.first.math.kinematics.ChassisSpeeds)</code></a> method, or via the <div class="block">Creates a new swerve drivebase subsystem. Robot is controlled via the <a href="#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)"><code>drive(edu.wpi.first.math.kinematics.ChassisSpeeds)</code></a> method, or via the
<code>setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[], boolean)</code> method. The <a href="#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)"><code>drive(edu.wpi.first.math.kinematics.ChassisSpeeds)</code></a> method incorporates kinematics-- it <a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[], boolean)</code></a> method. The <a href="#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)"><code>drive(edu.wpi.first.math.kinematics.ChassisSpeeds)</code></a> method incorporates kinematics-- it
takes a translation and rotation, as well as parameters for field-centric and closed-loop velocity control. takes a translation and rotation, as well as parameters for field-centric and closed-loop velocity control.
<code>setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[], boolean)</code> takes a list of SwerveModuleStates and directly passes them to the modules. <a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[], boolean)</code></a> takes a list of SwerveModuleStates and directly passes them to the modules.
This subsystem also handles odometry.</div> This subsystem also handles odometry.</div>
<dl class="notes"> <dl class="notes">
<dt>Parameters:</dt> <dt>Parameters:</dt>
@@ -745,6 +904,19 @@ loadScripts(document, 'script');</script>
</section> </section>
</li> </li>
<li> <li>
<section class="detail" id="setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[],boolean)">
<h3>setRawModuleStates</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setRawModuleStates</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState[]&nbsp;desiredStates,
boolean&nbsp;isOpenLoop)</span></div>
<div class="block">Set the module states (azimuth and velocity) directly. Used primarily for auto pathing.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>desiredStates</code> - A list of SwerveModuleStates to send to the modules.</dd>
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable closed-loop.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[],boolean)"> <section class="detail" id="setModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState[],boolean)">
<h3>setModuleStates</h3> <h3>setModuleStates</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setModuleStates</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState[]&nbsp;desiredStates, <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setModuleStates</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState[]&nbsp;desiredStates,
@@ -927,8 +1099,8 @@ loadScripts(document, 'script');</script>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setMaximumSpeed</span><wbr><span class="parameters">(double&nbsp;maximumSpeed, <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setMaximumSpeed</span><wbr><span class="parameters">(double&nbsp;maximumSpeed,
boolean&nbsp;updateModuleFeedforward, boolean&nbsp;updateModuleFeedforward,
double&nbsp;optimalVoltage)</span></div> double&nbsp;optimalVoltage)</span></div>
<div class="block">Set the maximum speed of the drive motors, modified <code>maxSpeedMPS</code> which is used for the <div class="block">Set the maximum speed of the drive motors, modified <a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> which is used for the
<code>setRawModuleStates(SwerveModuleState[], boolean)</code> function and <a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions. This function overrides <a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions. This function overrides
what was placed in the JSON and could damage your motor/robot if set too high or unachievable rates.</div> what was placed in the JSON and could damage your motor/robot if set too high or unachievable rates.</div>
<dl class="notes"> <dl class="notes">
@@ -945,8 +1117,8 @@ loadScripts(document, 'script');</script>
<section class="detail" id="setMaximumSpeed(double)"> <section class="detail" id="setMaximumSpeed(double)">
<h3>setMaximumSpeed</h3> <h3>setMaximumSpeed</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setMaximumSpeed</span><wbr><span class="parameters">(double&nbsp;maximumSpeed)</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setMaximumSpeed</span><wbr><span class="parameters">(double&nbsp;maximumSpeed)</span></div>
<div class="block">Set the maximum speed of the drive motors, modified <code>maxSpeedMPS</code> which is used for the <div class="block">Set the maximum speed of the drive motors, modified <a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> which is used for the
<code>setRawModuleStates(SwerveModuleState[], boolean)</code> function and <a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions. This function overrides <a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions. This function overrides
what was placed in the JSON and could damage your motor/robot if set too high or unachievable rates. Overwrites the what was placed in the JSON and could damage your motor/robot if set too high or unachievable rates. Overwrites the
<a href="SwerveModule.html#feedforward"><code>SwerveModule.feedforward</code></a>.</div> <a href="SwerveModule.html#feedforward"><code>SwerveModule.feedforward</code></a>.</div>

85
docs/swervelib/SwerveModule.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveModule (YAGSL-Example API)</title> <title>SwerveModule</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib, class: SwerveModule"> <meta name="description" content="declaration: package: swervelib, class: SwerveModule">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script> <script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li> <li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html#class">Help</a></li> <li><a href="../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -90,11 +91,31 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div> <div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div> <div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div> <div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div> <div class="col-first even-row-color"><code>private final <a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></div>
<div class="col-second even-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div> <div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Absolute encoder for swerve drive.</div>
</div>
<div class="col-first odd-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second odd-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Swerve Motors.</div>
</div>
<div class="col-first even-row-color"><code>private double</code></div>
<div class="col-second even-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
<div class="col-last even-row-color">
<div class="block">Angle offset from the absolute encoder.</div>
</div>
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
<div class="col-second odd-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Swerve module configuration options.</div> <div class="block">Swerve module configuration options.</div>
</div> </div>
<div class="col-first even-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second even-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
<div class="col-last even-row-color">
<div class="block">Swerve Motors.</div>
</div>
<div class="col-first odd-row-color"><code>edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div> <div class="col-first odd-row-color"><code>edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
<div class="col-second odd-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div> <div class="col-second odd-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
@@ -115,6 +136,16 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Module number for kinematics, usually 0 to 3.</div> <div class="block">Module number for kinematics, usually 0 to 3.</div>
</div> </div>
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></code></div>
<div class="col-second odd-row-color"><code><a href="#simModule" class="member-name-link">simModule</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Simulated swerve module.</div>
</div>
<div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
<div class="col-last even-row-color">
<div class="block">Encoder synchronization queued.</div>
</div>
</div> </div>
</section> </section>
</li> </li>
@@ -268,6 +299,27 @@ loadScripts(document, 'script');</script>
</section> </section>
</li> </li>
<li> <li>
<section class="detail" id="angleMotor">
<h3>angleMotor</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span>&nbsp;<span class="element-name">angleMotor</span></div>
<div class="block">Swerve Motors.</div>
</section>
</li>
<li>
<section class="detail" id="driveMotor">
<h3>driveMotor</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span>&nbsp;<span class="element-name">driveMotor</span></div>
<div class="block">Swerve Motors.</div>
</section>
</li>
<li>
<section class="detail" id="absoluteEncoder">
<h3>absoluteEncoder</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span>&nbsp;<span class="element-name">absoluteEncoder</span></div>
<div class="block">Absolute encoder for swerve drive.</div>
</section>
</li>
<li>
<section class="detail" id="moduleNumber"> <section class="detail" id="moduleNumber">
<h3>moduleNumber</h3> <h3>moduleNumber</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">moduleNumber</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">moduleNumber</span></div>
@@ -295,6 +347,27 @@ loadScripts(document, 'script');</script>
<div class="block">Last swerve module state applied.</div> <div class="block">Last swerve module state applied.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="angleOffset">
<h3>angleOffset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">angleOffset</span></div>
<div class="block">Angle offset from the absolute encoder.</div>
</section>
</li>
<li>
<section class="detail" id="simModule">
<h3>simModule</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></span>&nbsp;<span class="element-name">simModule</span></div>
<div class="block">Simulated swerve module.</div>
</section>
</li>
<li>
<section class="detail" id="synchronizeEncoderQueued">
<h3>synchronizeEncoderQueued</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">synchronizeEncoderQueued</span></div>
<div class="block">Encoder synchronization queued.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>

21
docs/swervelib/encoders/AnalogAbsoluteEncoderSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>AnalogAbsoluteEncoderSwerve (YAGSL-Example API)</title> <title>AnalogAbsoluteEncoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: AnalogAbsoluteEncoderSwerve"> <meta name="description" content="declaration: package: swervelib.encoders, class: AnalogAbsoluteEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -97,6 +98,11 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Encoder as Analog Input.</div> <div class="block">Encoder as Analog Input.</div>
</div> </div>
<div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Inversion state of the encoder.</div>
</div>
</div> </div>
<div class="inherited-list"> <div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3> <h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
@@ -192,6 +198,13 @@ loadScripts(document, 'script');</script>
<div class="block">Encoder as Analog Input.</div> <div class="block">Encoder as Analog Input.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="inverted">
<h3>inverted</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">inverted</span></div>
<div class="block">Inversion state of the encoder.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>

9
docs/swervelib/encoders/CANCoderSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>CANCoderSwerve (YAGSL-Example API)</title> <title>CANCoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: CANCoderSwerve"> <meta name="description" content="declaration: package: swervelib.encoders, class: CANCoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

21
docs/swervelib/encoders/CanAndCoderSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>CanAndCoderSwerve (YAGSL-Example API)</title> <title>CanAndCoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: CanAndCoderSwerve"> <meta name="description" content="declaration: package: swervelib.encoders, class: CanAndCoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -97,6 +98,11 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div> <div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div>
</div> </div>
<div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Inversion state of the encoder.</div>
</div>
</div> </div>
<div class="inherited-list"> <div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3> <h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
@@ -188,6 +194,13 @@ loadScripts(document, 'script');</script>
<div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div> <div class="block">The <code>Canandcoder</code> representing the CANandCoder on the CAN bus.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="inverted">
<h3>inverted</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">inverted</span></div>
<div class="block">Inversion state of the encoder.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>

49
docs/swervelib/encoders/PWMDutyCycleEncoderSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>PWMDutyCycleEncoderSwerve (YAGSL-Example API)</title> <title>PWMDutyCycleEncoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: PWMDutyCycleEncoderSwerve"> <meta name="description" content="declaration: package: swervelib.encoders, class: PWMDutyCycleEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -50,7 +51,7 @@ loadScripts(document, 'script');</script>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -92,6 +93,22 @@ loadScripts(document, 'script');</script>
<li> <li>
<section class="field-summary" id="field-summary"> <section class="field-summary" id="field-summary">
<h2>Field Summary</h2> <h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.DutyCycleEncoder</code></div>
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-last even-row-color">
<div class="block">Duty Cycle Encoder.</div>
</div>
<div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#isInverted" class="member-name-link">isInverted</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Inversion state.</div>
</div>
</div>
<div class="inherited-list"> <div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3> <h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div> <code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
@@ -170,6 +187,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="encoder">
<h3>encoder</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.DutyCycleEncoder</span>&nbsp;<span class="element-name">encoder</span></div>
<div class="block">Duty Cycle Encoder.</div>
</section>
</li>
<li>
<section class="detail" id="isInverted">
<h3>isInverted</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isInverted</span></div>
<div class="block">Inversion state.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

53
docs/swervelib/encoders/SparkMaxAnalogEncoderSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkMaxAnalogEncoderSwerve (YAGSL-Example API)</title> <title>SparkMaxAnalogEncoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxAnalogEncoderSwerve"> <meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxAnalogEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -140,29 +141,34 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div> <div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Run the configuration until it succeeds or times out.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Reset the encoder to factory defaults.</div> <div class="block">Reset the encoder to factory defaults.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the instantiated absolute encoder Object.</div> <div class="block">Get the instantiated absolute encoder Object.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the absolute position of the encoder.</div> <div class="block">Get the absolute position of the encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the velocity in degrees/sec.</div> <div class="block">Get the velocity in degrees/sec.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double&nbsp;offset)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div> <div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
</div> </div>
</div> </div>
@@ -218,6 +224,17 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2> <h2>Method Details</h2>
<ul class="member-list"> <ul class="member-list">
<li> <li>
<section class="detail" id="configureSparkMax(java.util.function.Supplier)">
<h3>configureSparkMax</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">configureSparkMax</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</span></div>
<div class="block">Run the configuration until it succeeds or times out.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="factoryDefault()"> <section class="detail" id="factoryDefault()">
<h3>factoryDefault</h3> <h3>factoryDefault</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">factoryDefault</span>()</div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">factoryDefault</span>()</div>

53
docs/swervelib/encoders/SparkMaxEncoderSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkMaxEncoderSwerve (YAGSL-Example API)</title> <title>SparkMaxEncoderSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxEncoderSwerve"> <meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -140,29 +141,34 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div> <div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Run the configuration until it succeeds or times out.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Reset the encoder to factory defaults.</div> <div class="block">Reset the encoder to factory defaults.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the instantiated absolute encoder Object.</div> <div class="block">Get the instantiated absolute encoder Object.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the absolute position of the encoder.</div> <div class="block">Get the absolute position of the encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the velocity in degrees/sec.</div> <div class="block">Get the velocity in degrees/sec.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double&nbsp;offset)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double&nbsp;offset)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the Absolute Encoder Offset inside of the SparkMax's Memory.</div> <div class="block">Sets the Absolute Encoder Offset inside of the SparkMax's Memory.</div>
</div> </div>
</div> </div>
@@ -219,6 +225,17 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2> <h2>Method Details</h2>
<ul class="member-list"> <ul class="member-list">
<li> <li>
<section class="detail" id="configureSparkMax(java.util.function.Supplier)">
<h3>configureSparkMax</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">configureSparkMax</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</span></div>
<div class="block">Run the configuration until it succeeds or times out.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="factoryDefault()"> <section class="detail" id="factoryDefault()">
<h3>factoryDefault</h3> <h3>factoryDefault</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">factoryDefault</span>()</div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">factoryDefault</span>()</div>

9
docs/swervelib/encoders/SwerveAbsoluteEncoder.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveAbsoluteEncoder (YAGSL-Example API)</title> <title>SwerveAbsoluteEncoder</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders, class: SwerveAbsoluteEncoder"> <meta name="description" content="declaration: package: swervelib.encoders, class: SwerveAbsoluteEncoder">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/encoders/package-summary.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.encoders (YAGSL-Example API)</title> <title>swervelib.encoders</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.encoders"> <meta name="description" content="declaration: package: swervelib.encoders">
<meta name="generator" content="javadoc/PackageWriterImpl"> <meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-declaration-page"> <body class="package-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li> <li class="nav-bar-cell1-rev">Package</li>
<li>Class</li> <li>Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#package">Help</a></li> <li><a href="../../help-doc.html#package">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/encoders/package-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.encoders Class Hierarchy (YAGSL-Example API)</title> <title>swervelib.encoders Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="tree: package: swervelib.encoders"> <meta name="description" content="tree: package: swervelib.encoders">
<meta name="generator" content="javadoc/PackageTreeWriter"> <meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-tree-page"> <body class="package-tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#tree">Help</a></li> <li><a href="../../help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>

57
docs/swervelib/imu/ADIS16448Swerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>ADIS16448Swerve (YAGSL-Example API)</title> <title>ADIS16448Swerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: ADIS16448Swerve"> <meta name="description" content="declaration: package: swervelib.imu, class: ADIS16448Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.ADIS16448_IMU</code></div>
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
<div class="col-last even-row-color">
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the ADIS16448.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.ADIS16448_IMU</span>&nbsp;<span class="element-name">imu</span></div>
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the ADIS16448.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

57
docs/swervelib/imu/ADIS16470Swerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>ADIS16470Swerve (YAGSL-Example API)</title> <title>ADIS16470Swerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: ADIS16470Swerve"> <meta name="description" content="declaration: package: swervelib.imu, class: ADIS16470Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.ADIS16470_IMU</code></div>
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
<div class="col-last even-row-color">
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the ADIS16470.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.ADIS16470_IMU</span>&nbsp;<span class="element-name">imu</span></div>
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the ADIS16470.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

57
docs/swervelib/imu/ADXRS450Swerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>ADXRS450Swerve (YAGSL-Example API)</title> <title>ADXRS450Swerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: ADXRS450Swerve"> <meta name="description" content="declaration: package: swervelib.imu, class: ADXRS450Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.ADXRS450_Gyro</code></div>
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
<div class="col-last even-row-color">
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the ADXRS450.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.ADXRS450_Gyro</span>&nbsp;<span class="element-name">imu</span></div>
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the ADXRS450.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

57
docs/swervelib/imu/AnalogGyroSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>AnalogGyroSwerve (YAGSL-Example API)</title> <title>AnalogGyroSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: AnalogGyroSwerve"> <meta name="description" content="declaration: package: swervelib.imu, class: AnalogGyroSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.AnalogGyro</code></div>
<div class="col-second even-row-color"><code><a href="#gyro" class="member-name-link">gyro</a></code></div>
<div class="col-last even-row-color">
<div class="block">Gyroscope object.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the analog gyro.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="gyro">
<h3>gyro</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj.AnalogGyro</span>&nbsp;<span class="element-name">gyro</span></div>
<div class="block">Gyroscope object.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the analog gyro.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

57
docs/swervelib/imu/NavXSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>NavXSwerve (YAGSL-Example API)</title> <title>NavXSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: NavXSwerve"> <meta name="description" content="declaration: package: swervelib.imu, class: NavXSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private com.kauailabs.navx.frc.AHRS</code></div>
<div class="col-second even-row-color"><code><a href="#gyro" class="member-name-link">gyro</a></code></div>
<div class="col-last even-row-color">
<div class="block">NavX IMU.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the NavX.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -164,6 +187,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="gyro">
<h3>gyro</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">com.kauailabs.navx.frc.AHRS</span>&nbsp;<span class="element-name">gyro</span></div>
<div class="block">NavX IMU.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the NavX.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

57
docs/swervelib/imu/Pigeon2Swerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Pigeon2Swerve (YAGSL-Example API)</title> <title>Pigeon2Swerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: Pigeon2Swerve"> <meta name="description" content="declaration: package: swervelib.imu, class: Pigeon2Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>(package private) com.ctre.phoenix6.hardware.Pigeon2</code></div>
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
<div class="col-last even-row-color">
<div class="block">Pigeon2 IMU device.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the Pigeon 2.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -161,6 +184,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="return-type">com.ctre.phoenix6.hardware.Pigeon2</span>&nbsp;<span class="element-name">imu</span></div>
<div class="block">Pigeon2 IMU device.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the Pigeon 2.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

57
docs/swervelib/imu/PigeonSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>PigeonSwerve (YAGSL-Example API)</title> <title>PigeonSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: PigeonSwerve"> <meta name="description" content="declaration: package: swervelib.imu, class: PigeonSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>(package private) com.ctre.phoenix.sensors.WPI_PigeonIMU</code></div>
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
<div class="col-last even-row-color">
<div class="block">Pigeon v1 IMU device.</div>
</div>
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Offset for the Pigeon.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== --> <!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li> <li>
<section class="constructor-summary" id="constructor-summary"> <section class="constructor-summary" id="constructor-summary">
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="imu">
<h3>imu</h3>
<div class="member-signature"><span class="return-type">com.ctre.phoenix.sensors.WPI_PigeonIMU</span>&nbsp;<span class="element-name">imu</span></div>
<div class="block">Pigeon v1 IMU device.</div>
</section>
</li>
<li>
<section class="detail" id="offset">
<h3>offset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span>&nbsp;<span class="element-name">offset</span></div>
<div class="block">Offset for the Pigeon.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

9
docs/swervelib/imu/SwerveIMU.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveIMU (YAGSL-Example API)</title> <title>SwerveIMU</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu, class: SwerveIMU"> <meta name="description" content="declaration: package: swervelib.imu, class: SwerveIMU">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/imu/package-summary.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.imu (YAGSL-Example API)</title> <title>swervelib.imu</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.imu"> <meta name="description" content="declaration: package: swervelib.imu">
<meta name="generator" content="javadoc/PackageWriterImpl"> <meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-declaration-page"> <body class="package-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li> <li class="nav-bar-cell1-rev">Package</li>
<li>Class</li> <li>Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#package">Help</a></li> <li><a href="../../help-doc.html#package">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/imu/package-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.imu Class Hierarchy (YAGSL-Example API)</title> <title>swervelib.imu Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="tree: package: swervelib.imu"> <meta name="description" content="tree: package: swervelib.imu">
<meta name="generator" content="javadoc/PackageTreeWriter"> <meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-tree-page"> <body class="package-tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#tree">Help</a></li> <li><a href="../../help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/math/Matter.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>Matter (YAGSL-Example API)</title> <title>Matter</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.math, class: Matter"> <meta name="description" content="declaration: package: swervelib.math, class: Matter">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

106
docs/swervelib/math/SwerveMath.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveMath (YAGSL-Example API)</title> <title>SwerveMath</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.math, class: SwerveMath"> <meta name="description" content="declaration: package: swervelib.math, class: SwerveMath">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -119,79 +120,87 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Algebraically apply a deadband using a piece wise function.</div> <div class="block">Algebraically apply a deadband using a piece wise function.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateDegreesPerSteeringRotation(double,double)" class="member-name-link">calculateDegreesPerSteeringRotation</a><wbr>(double&nbsp;angleGearRatio, <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">calcMaxAccel</a><wbr>(edu.wpi.first.math.geometry.Rotation2d&nbsp;angle,
double&nbsp;pulsePerRotation)</code></div> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Matter.html" title="class in swervelib.math">Matter</a>&gt;&nbsp;matter,
double&nbsp;robotMass,
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Calculate the degrees per steering rotation for the integrated encoder.</div> <div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double&nbsp;cof)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateDegreesPerSteeringRotation(double,double)" class="member-name-link">calculateDegreesPerSteeringRotation</a><wbr>(double&nbsp;angleGearRatio,
double&nbsp;pulsePerRotation)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.</div> <div class="block">Calculate the degrees per steering rotation for the integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double,double,double,double,double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double&nbsp;stallTorqueNm, <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double&nbsp;cof)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double,double,double,double,double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double&nbsp;stallTorqueNm,
double&nbsp;gearRatio, double&nbsp;gearRatio,
double&nbsp;moduleCount, double&nbsp;moduleCount,
double&nbsp;wheelDiameter, double&nbsp;wheelDiameter,
double&nbsp;robotMass)</code></div> double&nbsp;robotMass)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Calculate the maximum theoretical acceleration without friction.</div> <div class="block">Calculate the maximum theoretical acceleration without friction.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAngularVelocity(double,double,double)" class="member-name-link">calculateMaxAngularVelocity</a><wbr>(double&nbsp;maxSpeed, <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAngularVelocity(double,double,double)" class="member-name-link">calculateMaxAngularVelocity</a><wbr>(double&nbsp;maxSpeed,
double&nbsp;furthestModuleX, double&nbsp;furthestModuleX,
double&nbsp;furthestModuleY)</code></div> double&nbsp;furthestModuleY)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Calculate the maximum angular velocity.</div> <div class="block">Calculate the maximum angular velocity.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMetersPerRotation(double,double,double)" class="member-name-link">calculateMetersPerRotation</a><wbr>(double&nbsp;wheelDiameter, <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMetersPerRotation(double,double,double)" class="member-name-link">calculateMetersPerRotation</a><wbr>(double&nbsp;wheelDiameter,
double&nbsp;driveGearRatio, double&nbsp;driveGearRatio,
double&nbsp;pulsePerRotation)</code></div> double&nbsp;pulsePerRotation)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Calculate the meters per rotation for the integrated encoder.</div> <div class="block">Calculate the meters per rotation for the integrated encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createDriveFeedforward(double,double,double)" class="member-name-link">createDriveFeedforward</a><wbr>(double&nbsp;optimalVoltage, <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createDriveFeedforward(double,double,double)" class="member-name-link">createDriveFeedforward</a><wbr>(double&nbsp;optimalVoltage,
double&nbsp;maxSpeed, double&nbsp;maxSpeed,
double&nbsp;wheelGripCoefficientOfFriction)</code></div> double&nbsp;wheelGripCoefficientOfFriction)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Create the drive feedforward for swerve modules.</div> <div class="block">Create the drive feedforward for swerve modules.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSwerveModule(swervelib.SwerveModule%5B%5D,boolean,boolean)" class="member-name-link">getSwerveModule</a><wbr>(<a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]&nbsp;modules, <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSwerveModule(swervelib.SwerveModule%5B%5D,boolean,boolean)" class="member-name-link">getSwerveModule</a><wbr>(<a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[]&nbsp;modules,
boolean&nbsp;front, boolean&nbsp;front,
boolean&nbsp;left)</code></div> boolean&nbsp;left)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Get the fruthest module from center based on the module locations.</div> <div class="block">Get the fruthest module from center based on the module locations.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Translation2d</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Translation2d</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity</a><wbr>(edu.wpi.first.math.geometry.Translation2d&nbsp;commandedVelocity, <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity</a><wbr>(edu.wpi.first.math.geometry.Translation2d&nbsp;commandedVelocity,
edu.wpi.first.math.kinematics.ChassisSpeeds&nbsp;fieldVelocity, edu.wpi.first.math.kinematics.ChassisSpeeds&nbsp;fieldVelocity,
edu.wpi.first.math.geometry.Pose2d&nbsp;robotPose, edu.wpi.first.math.geometry.Pose2d&nbsp;robotPose,
double&nbsp;loopTime, double&nbsp;loopTime,
double&nbsp;robotMass, double&nbsp;robotMass,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Matter.html" title="class in swervelib.math">Matter</a>&gt;&nbsp;matter, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Matter.html" title="class in swervelib.math">Matter</a>&gt;&nbsp;matter,
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;config)</code></div> <a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;config)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List&lt;swervelib.math.Matter&gt;, double, swervelib.parser.SwerveDriveConfiguration)</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizeAngle(double)" class="member-name-link">normalizeAngle</a><wbr>(double&nbsp;angle)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Normalize an angle to be within 0 to 360.</div> <div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List&lt;swervelib.math.Matter&gt;, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope</a><wbr>(double&nbsp;scopeReference, <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizeAngle(double)" class="member-name-link">normalizeAngle</a><wbr>(double&nbsp;angle)</code></div>
double&nbsp;newAngle)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Normalize an angle to be within 0 to 360.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope</a><wbr>(double&nbsp;scopeReference,
double&nbsp;newAngle)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Put an angle within the 360 deg scope of a reference.</div> <div class="block">Put an angle within the 360 deg scope of a reference.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Twist2d</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Twist2d</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#PoseLog(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">PoseLog</a><wbr>(edu.wpi.first.math.geometry.Pose2d&nbsp;transform)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#PoseLog(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">PoseLog</a><wbr>(edu.wpi.first.math.geometry.Pose2d&nbsp;transform)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Logical inverse of the Pose exponential from 254.</div> <div class="block">Logical inverse of the Pose exponential from 254.</div>
</div> </div>
</div> </div>
@@ -359,6 +368,27 @@ loadScripts(document, 'script');</script>
</section> </section>
</li> </li>
<li> <li>
<section class="detail" id="calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)">
<h3>calcMaxAccel</h3>
<div class="member-signature"><span class="modifiers">private static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">calcMaxAccel</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Rotation2d&nbsp;angle,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Matter.html" title="class in swervelib.math">Matter</a>&gt;&nbsp;matter,
double&nbsp;robotMass,
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;config)</span></div>
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot. Reads arm position from
NetworkTables and is passed the direction in question.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>angle</code> - The direction in which to calculate max acceleration, as a Rotation2d. Note that this is
robot-relative.</dd>
<dd><code>matter</code> - Matter that the robot is composed of in kg. (Includes chassis)</dd>
<dd><code>robotMass</code> - The weight of the robot in kg. (Including manipulators, etc).</dd>
<dd><code>config</code> - The swerve drive configuration.</dd>
<dt>Returns:</dt>
<dd>Maximum acceleration allowed in the robot direction.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="PoseLog(edu.wpi.first.math.geometry.Pose2d)"> <section class="detail" id="PoseLog(edu.wpi.first.math.geometry.Pose2d)">
<h3>PoseLog</h3> <h3>PoseLog</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Twist2d</span>&nbsp;<span class="element-name">PoseLog</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d&nbsp;transform)</span></div> <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Twist2d</span>&nbsp;<span class="element-name">PoseLog</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d&nbsp;transform)</span></div>
@@ -381,7 +411,7 @@ loadScripts(document, 'script');</script>
double&nbsp;robotMass, double&nbsp;robotMass,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Matter.html" title="class in swervelib.math">Matter</a>&gt;&nbsp;matter, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="Matter.html" title="class in swervelib.math">Matter</a>&gt;&nbsp;matter,
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;config)</span></div> <a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;config)</span></div>
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List&lt;swervelib.math.Matter&gt;, double, swervelib.parser.SwerveDriveConfiguration)</code>. <div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List&lt;swervelib.math.Matter&gt;, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.
Note that this takes and returns field-relative velocities.</div> Note that this takes and returns field-relative velocities.</div>
<dl class="notes"> <dl class="notes">
<dt>Parameters:</dt> <dt>Parameters:</dt>

9
docs/swervelib/math/package-summary.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.math (YAGSL-Example API)</title> <title>swervelib.math</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.math"> <meta name="description" content="declaration: package: swervelib.math">
<meta name="generator" content="javadoc/PackageWriterImpl"> <meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-declaration-page"> <body class="package-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li> <li class="nav-bar-cell1-rev">Package</li>
<li>Class</li> <li>Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#package">Help</a></li> <li><a href="../../help-doc.html#package">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/math/package-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.math Class Hierarchy (YAGSL-Example API)</title> <title>swervelib.math Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="tree: package: swervelib.math"> <meta name="description" content="tree: package: swervelib.math">
<meta name="generator" content="javadoc/PackageTreeWriter"> <meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-tree-page"> <body class="package-tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#tree">Help</a></li> <li><a href="../../help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>

268
docs/swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html Normal file
View File

@@ -0,0 +1,268 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkFlexSwerve.SparkMAX_slotIdx</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkFlexSwerve, enum: SparkMAX_slotIdx">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#enum-constant-summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#enum-constant-detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">swervelib.motors</a></div>
<h1 title="Enum Class SparkFlexSwerve.SparkMAX_slotIdx" class="title">Enum Class SparkFlexSwerve.SparkMAX_slotIdx</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a>&lt;<a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a>&gt;
<div class="inheritance">swervelib.motors.SparkFlexSwerve.SparkMAX_slotIdx</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">static enum </span><span class="element-name type-name-label">SparkFlexSwerve.SparkMAX_slotIdx</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a>&gt;</span></div>
<div class="block">REV Slots for PID configuration.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>&gt;&gt;</code></div>
</section>
</li>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<li>
<section class="constants-summary" id="enum-constant-summary">
<h2>Enum Constant Summary</h2>
<div class="caption"><span>Enum Constants</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Enum Constant</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="#Position" class="member-name-link">Position</a></code></div>
<div class="col-last even-row-color">
<div class="block">Slot 1, used for position PID's.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#Simulation" class="member-name-link">Simulation</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Slot 3, used arbitrarily.</div>
</div>
<div class="col-first even-row-color"><code><a href="#Velocity" class="member-name-link">Velocity</a></code></div>
<div class="col-last even-row-color">
<div class="block">Slot 2, used for velocity PID's.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns the enum constant of this class with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<li>
<section class="constant-details" id="enum-constant-detail">
<h2>Enum Constant Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="Position">
<h3>Position</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">Position</span></div>
<div class="block">Slot 1, used for position PID's.</div>
</section>
</li>
<li>
<section class="detail" id="Velocity">
<h3>Velocity</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">Velocity</span></div>
<div class="block">Slot 2, used for velocity PID's.</div>
</section>
</li>
<li>
<section class="detail" id="Simulation">
<h3>Simulation</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">Simulation</span></div>
<div class="block">Slot 3, used arbitrarily. (Documentation show simulations).</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SparkMAX_slotIdx</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="element-name">SparkMAX_slotIdx</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="values()">
<h3>values</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="valueOf(java.lang.String)">
<h3>valueOf</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the enum constant of this class with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this class. (Extraneous whitespace characters are
not permitted.)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt>Returns:</dt>
<dd>the enum constant with the specified name</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>

156
docs/swervelib/motors/SparkFlexSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkFlexSwerve (YAGSL-Example API)</title> <title>SparkFlexSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkFlexSwerve"> <meta name="description" content="declaration: package: swervelib.motors, class: SparkFlexSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -43,7 +44,7 @@ loadScripts(document, 'script');</script>
<div> <div>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
@@ -83,6 +84,23 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>(package private) static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></code></div>
<div class="col-last even-row-color">
<div class="block">REV Slots for PID configuration.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== --> <!-- =========== FIELD SUMMARY =========== -->
<li> <li>
<section class="field-summary" id="field-summary"> <section class="field-summary" id="field-summary">
@@ -102,14 +120,19 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Integrated encoder.</div> <div class="block">Integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color"><code>com.revrobotics.CANSparkFlex</code></div> <div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div> <div class="col-second even-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Factory default already occurred.</div>
</div>
<div class="col-first odd-row-color"><code>com.revrobotics.CANSparkFlex</code></div>
<div class="col-second odd-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">SparkMAX Instance.</div> <div class="block">SparkMAX Instance.</div>
</div> </div>
<div class="col-first odd-row-color"><code>com.revrobotics.SparkPIDController</code></div> <div class="col-first even-row-color"><code>com.revrobotics.SparkPIDController</code></div>
<div class="col-second odd-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div> <div class="col-second even-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last even-row-color">
<div class="block">Closed-loop PID controller.</div> <div class="block">Closed-loop PID controller.</div>
</div> </div>
</div> </div>
@@ -185,83 +208,88 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the PID wrapping for the position closed loop controller.</div> <div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefaults()" class="member-name-link">factoryDefaults</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkFlex(java.util.function.Supplier)" class="member-name-link">configureSparkFlex</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Run the configuration until it succeeds or times out.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefaults()" class="member-name-link">factoryDefaults</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the factory defaults.</div> <div class="block">Configure the factory defaults.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMotor()" class="member-name-link">getMotor</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMotor()" class="member-name-link">getMotor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the motor object from the module.</div> <div class="block">Get the motor object from the module.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the position of the integrated encoder.</div> <div class="block">Get the position of the integrated encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the velocity of the integrated encoder.</div> <div class="block">Get the velocity of the integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div> <div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double)" class="member-name-link">set</a><wbr>(double&nbsp;percentOutput)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double)" class="member-name-link">set</a><wbr>(double&nbsp;percentOutput)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the percentage output.</div> <div class="block">Set the percentage output.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder</a><wbr>(<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;encoder)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder</a><wbr>(<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;encoder)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div> <div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int&nbsp;currentLimit)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int&nbsp;currentLimit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with <div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div> voltage compensation.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean&nbsp;inverted)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean&nbsp;inverted)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the motor to be inverted.</div> <div class="block">Set the motor to be inverted.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoopRampRate(double)" class="member-name-link">setLoopRampRate</a><wbr>(double&nbsp;rampRate)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoopRampRate(double)" class="member-name-link">setLoopRampRate</a><wbr>(double&nbsp;rampRate)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the maximum rate the open/closed loop output can change by.</div> <div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean&nbsp;isBrakeMode)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean&nbsp;isBrakeMode)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the idle mode.</div> <div class="block">Set the idle mode.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPosition(double)" class="member-name-link">setPosition</a><wbr>(double&nbsp;position)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPosition(double)" class="member-name-link">setPosition</a><wbr>(double&nbsp;position)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the integrated encoder position.</div> <div class="block">Set the integrated encoder position.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint, <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward, double&nbsp;feedforward)</code></div>
double&nbsp;position)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div> <div class="block">Set the closed loop PID controller reference point.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation</a><wbr>(double&nbsp;nominalVoltage)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward,
double&nbsp;position)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation</a><wbr>(double&nbsp;nominalVoltage)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the voltage compensation for the swerve module motor.</div> <div class="block">Set the voltage compensation for the swerve module motor.</div>
</div> </div>
</div> </div>
@@ -309,6 +337,13 @@ loadScripts(document, 'script');</script>
<div class="block">Closed-loop PID controller.</div> <div class="block">Closed-loop PID controller.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="factoryDefaultOccurred">
<h3>factoryDefaultOccurred</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">factoryDefaultOccurred</span></div>
<div class="block">Factory default already occurred.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>
@@ -352,6 +387,17 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2> <h2>Method Details</h2>
<ul class="member-list"> <ul class="member-list">
<li> <li>
<section class="detail" id="configureSparkFlex(java.util.function.Supplier)">
<h3>configureSparkFlex</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">configureSparkFlex</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</span></div>
<div class="block">Run the configuration until it succeeds or times out.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setVoltageCompensation(double)"> <section class="detail" id="setVoltageCompensation(double)">
<h3>setVoltageCompensation</h3> <h3>setVoltageCompensation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltageCompensation</span><wbr><span class="parameters">(double&nbsp;nominalVoltage)</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltageCompensation</span><wbr><span class="parameters">(double&nbsp;nominalVoltage)</span></div>

137
docs/swervelib/motors/SparkMaxBrushedMotorSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkMaxBrushedMotorSwerve (YAGSL-Example API)</title> <title>SparkMaxBrushedMotorSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxBrushedMotorSwerve"> <meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxBrushedMotorSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -102,14 +103,19 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Integrated encoder.</div> <div class="block">Integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color"><code>com.revrobotics.CANSparkMax</code></div> <div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div> <div class="col-second even-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Factory default already occurred.</div>
</div>
<div class="col-first odd-row-color"><code>com.revrobotics.CANSparkMax</code></div>
<div class="col-second odd-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">SparkMAX Instance.</div> <div class="block">SparkMAX Instance.</div>
</div> </div>
<div class="col-first odd-row-color"><code>com.revrobotics.SparkPIDController</code></div> <div class="col-first even-row-color"><code>com.revrobotics.SparkPIDController</code></div>
<div class="col-second odd-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div> <div class="col-second even-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last even-row-color">
<div class="block">Closed-loop PID controller.</div> <div class="block">Closed-loop PID controller.</div>
</div> </div>
</div> </div>
@@ -191,83 +197,88 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the PID wrapping for the position closed loop controller.</div> <div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefaults()" class="member-name-link">factoryDefaults</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Run the configuration until it succeeds or times out.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefaults()" class="member-name-link">factoryDefaults</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the factory defaults.</div> <div class="block">Configure the factory defaults.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMotor()" class="member-name-link">getMotor</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMotor()" class="member-name-link">getMotor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the motor object from the module.</div> <div class="block">Get the motor object from the module.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the position of the integrated encoder.</div> <div class="block">Get the position of the integrated encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the velocity of the integrated encoder.</div> <div class="block">Get the velocity of the integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div> <div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double)" class="member-name-link">set</a><wbr>(double&nbsp;percentOutput)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double)" class="member-name-link">set</a><wbr>(double&nbsp;percentOutput)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the percentage output.</div> <div class="block">Set the percentage output.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder</a><wbr>(<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;encoder)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder</a><wbr>(<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;encoder)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div> <div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int&nbsp;currentLimit)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int&nbsp;currentLimit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with <div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div> voltage compensation.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean&nbsp;inverted)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean&nbsp;inverted)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the motor to be inverted.</div> <div class="block">Set the motor to be inverted.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoopRampRate(double)" class="member-name-link">setLoopRampRate</a><wbr>(double&nbsp;rampRate)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoopRampRate(double)" class="member-name-link">setLoopRampRate</a><wbr>(double&nbsp;rampRate)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the maximum rate the open/closed loop output can change by.</div> <div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean&nbsp;isBrakeMode)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean&nbsp;isBrakeMode)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the idle mode.</div> <div class="block">Set the idle mode.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPosition(double)" class="member-name-link">setPosition</a><wbr>(double&nbsp;position)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPosition(double)" class="member-name-link">setPosition</a><wbr>(double&nbsp;position)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the integrated encoder position.</div> <div class="block">Set the integrated encoder position.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint, <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward, double&nbsp;feedforward)</code></div>
double&nbsp;position)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div> <div class="block">Set the closed loop PID controller reference point.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation</a><wbr>(double&nbsp;nominalVoltage)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward,
double&nbsp;position)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation</a><wbr>(double&nbsp;nominalVoltage)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the voltage compensation for the swerve module motor.</div> <div class="block">Set the voltage compensation for the swerve module motor.</div>
</div> </div>
</div> </div>
@@ -315,6 +326,13 @@ loadScripts(document, 'script');</script>
<div class="block">Closed-loop PID controller.</div> <div class="block">Closed-loop PID controller.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="factoryDefaultOccurred">
<h3>factoryDefaultOccurred</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">factoryDefaultOccurred</span></div>
<div class="block">Factory default already occurred.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>
@@ -370,6 +388,17 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2> <h2>Method Details</h2>
<ul class="member-list"> <ul class="member-list">
<li> <li>
<section class="detail" id="configureSparkMax(java.util.function.Supplier)">
<h3>configureSparkMax</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">configureSparkMax</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</span></div>
<div class="block">Run the configuration until it succeeds or times out.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setVoltageCompensation(double)"> <section class="detail" id="setVoltageCompensation(double)">
<h3>setVoltageCompensation</h3> <h3>setVoltageCompensation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltageCompensation</span><wbr><span class="parameters">(double&nbsp;nominalVoltage)</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltageCompensation</span><wbr><span class="parameters">(double&nbsp;nominalVoltage)</span></div>

268
docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html Normal file
View File

@@ -0,0 +1,268 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkMaxSwerve.SparkMAX_slotIdx</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxSwerve, enum: SparkMAX_slotIdx">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#enum-constant-summary">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#enum-constant-detail">Enum Constants</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">swervelib.motors</a></div>
<h1 title="Enum Class SparkMaxSwerve.SparkMAX_slotIdx" class="title">Enum Class SparkMaxSwerve.SparkMAX_slotIdx</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a>&lt;<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>&gt;
<div class="inheritance">swervelib.motors.SparkMaxSwerve.SparkMAX_slotIdx</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
</dl>
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">static enum </span><span class="element-name type-name-label">SparkMaxSwerve.SparkMAX_slotIdx</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>&gt;</span></div>
<div class="block">REV Slots for PID configuration.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>&gt;&gt;</code></div>
</section>
</li>
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
<li>
<section class="constants-summary" id="enum-constant-summary">
<h2>Enum Constant Summary</h2>
<div class="caption"><span>Enum Constants</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Enum Constant</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="#Position" class="member-name-link">Position</a></code></div>
<div class="col-last even-row-color">
<div class="block">Slot 1, used for position PID's.</div>
</div>
<div class="col-first odd-row-color"><code><a href="#Simulation" class="member-name-link">Simulation</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Slot 3, used arbitrarily.</div>
</div>
<div class="col-first even-row-color"><code><a href="#Velocity" class="member-name-link">Velocity</a></code></div>
<div class="col-last even-row-color">
<div class="block">Slot 2, used for velocity PID's.</div>
</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private </code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns the enum constant of this class with the specified name.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>[]</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ ENUM CONSTANT DETAIL =========== -->
<li>
<section class="constant-details" id="enum-constant-detail">
<h2>Enum Constant Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="Position">
<h3>Position</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">Position</span></div>
<div class="block">Slot 1, used for position PID's.</div>
</section>
</li>
<li>
<section class="detail" id="Velocity">
<h3>Velocity</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">Velocity</span></div>
<div class="block">Slot 2, used for velocity PID's.</div>
</section>
</li>
<li>
<section class="detail" id="Simulation">
<h3>Simulation</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">Simulation</span></div>
<div class="block">Slot 3, used arbitrarily. (Documentation show simulations).</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>SparkMAX_slotIdx</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="element-name">SparkMAX_slotIdx</span>()</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="values()">
<h3>values</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="valueOf(java.lang.String)">
<h3>valueOf</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Returns the enum constant of this class with the specified name.
The string must match <i>exactly</i> an identifier used to declare an
enum constant in this class. (Extraneous whitespace characters are
not permitted.)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
<dt>Returns:</dt>
<dd>the enum constant with the specified name</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>

156
docs/swervelib/motors/SparkMaxSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SparkMaxSwerve (YAGSL-Example API)</title> <title>SparkMaxSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxSwerve"> <meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -43,7 +44,7 @@ loadScripts(document, 'script');</script>
<div> <div>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Summary:&nbsp;</li> <li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li> <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li> <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li> <li><a href="#method-summary">Method</a></li>
@@ -83,6 +84,23 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="summary"> <section class="summary">
<ul class="summary-list"> <ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>(package private) static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></code></div>
<div class="col-last even-row-color">
<div class="block">REV Slots for PID configuration.</div>
</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== --> <!-- =========== FIELD SUMMARY =========== -->
<li> <li>
<section class="field-summary" id="field-summary"> <section class="field-summary" id="field-summary">
@@ -102,14 +120,19 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Integrated encoder.</div> <div class="block">Integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color"><code>com.revrobotics.CANSparkMax</code></div> <div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div> <div class="col-second even-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Factory default already occurred.</div>
</div>
<div class="col-first odd-row-color"><code>com.revrobotics.CANSparkMax</code></div>
<div class="col-second odd-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">SparkMAX Instance.</div> <div class="block">SparkMAX Instance.</div>
</div> </div>
<div class="col-first odd-row-color"><code>com.revrobotics.SparkPIDController</code></div> <div class="col-first even-row-color"><code>com.revrobotics.SparkPIDController</code></div>
<div class="col-second odd-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div> <div class="col-second even-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last even-row-color">
<div class="block">Closed-loop PID controller.</div> <div class="block">Closed-loop PID controller.</div>
</div> </div>
</div> </div>
@@ -187,83 +210,88 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the PID wrapping for the position closed loop controller.</div> <div class="block">Configure the PID wrapping for the position closed loop controller.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefaults()" class="member-name-link">factoryDefaults</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Run the configuration until it succeeds or times out.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefaults()" class="member-name-link">factoryDefaults</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Configure the factory defaults.</div> <div class="block">Configure the factory defaults.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMotor()" class="member-name-link">getMotor</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMotor()" class="member-name-link">getMotor</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the motor object from the module.</div> <div class="block">Get the motor object from the module.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the position of the integrated encoder.</div> <div class="block">Get the position of the integrated encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the velocity of the integrated encoder.</div> <div class="block">Get the velocity of the integrated encoder.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder</a>()</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div> <div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double)" class="member-name-link">set</a><wbr>(double&nbsp;percentOutput)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(double)" class="member-name-link">set</a><wbr>(double&nbsp;percentOutput)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the percentage output.</div> <div class="block">Set the percentage output.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder</a><wbr>(<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;encoder)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder</a><wbr>(<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;encoder)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div> <div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int&nbsp;currentLimit)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int&nbsp;currentLimit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with <div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div> voltage compensation.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean&nbsp;inverted)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean&nbsp;inverted)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the motor to be inverted.</div> <div class="block">Set the motor to be inverted.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoopRampRate(double)" class="member-name-link">setLoopRampRate</a><wbr>(double&nbsp;rampRate)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoopRampRate(double)" class="member-name-link">setLoopRampRate</a><wbr>(double&nbsp;rampRate)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the maximum rate the open/closed loop output can change by.</div> <div class="block">Set the maximum rate the open/closed loop output can change by.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean&nbsp;isBrakeMode)</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean&nbsp;isBrakeMode)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the idle mode.</div> <div class="block">Set the idle mode.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPosition(double)" class="member-name-link">setPosition</a><wbr>(double&nbsp;position)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPosition(double)" class="member-name-link">setPosition</a><wbr>(double&nbsp;position)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the integrated encoder position.</div> <div class="block">Set the integrated encoder position.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint, <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward, double&nbsp;feedforward)</code></div>
double&nbsp;position)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div> <div class="block">Set the closed loop PID controller reference point.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation</a><wbr>(double&nbsp;nominalVoltage)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setReference(double,double,double)" class="member-name-link">setReference</a><wbr>(double&nbsp;setpoint,
double&nbsp;feedforward,
double&nbsp;position)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the closed loop PID controller reference point.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation</a><wbr>(double&nbsp;nominalVoltage)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Set the voltage compensation for the swerve module motor.</div> <div class="block">Set the voltage compensation for the swerve module motor.</div>
</div> </div>
</div> </div>
@@ -311,6 +339,13 @@ loadScripts(document, 'script');</script>
<div class="block">Closed-loop PID controller.</div> <div class="block">Closed-loop PID controller.</div>
</section> </section>
</li> </li>
<li>
<section class="detail" id="factoryDefaultOccurred">
<h3>factoryDefaultOccurred</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">factoryDefaultOccurred</span></div>
<div class="block">Factory default already occurred.</div>
</section>
</li>
</ul> </ul>
</section> </section>
</li> </li>
@@ -354,6 +389,17 @@ loadScripts(document, 'script');</script>
<h2>Method Details</h2> <h2>Method Details</h2>
<ul class="member-list"> <ul class="member-list">
<li> <li>
<section class="detail" id="configureSparkMax(java.util.function.Supplier)">
<h3>configureSparkMax</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">configureSparkMax</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a>&lt;com.revrobotics.REVLibError&gt;&nbsp;config)</span></div>
<div class="block">Run the configuration until it succeeds or times out.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setVoltageCompensation(double)"> <section class="detail" id="setVoltageCompensation(double)">
<h3>setVoltageCompensation</h3> <h3>setVoltageCompensation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltageCompensation</span><wbr><span class="parameters">(double&nbsp;nominalVoltage)</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltageCompensation</span><wbr><span class="parameters">(double&nbsp;nominalVoltage)</span></div>

9
docs/swervelib/motors/SwerveMotor.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveMotor (YAGSL-Example API)</title> <title>SwerveMotor</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: SwerveMotor"> <meta name="description" content="declaration: package: swervelib.motors, class: SwerveMotor">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

113
docs/swervelib/motors/TalonFXSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>TalonFXSwerve (YAGSL-Example API)</title> <title>TalonFXSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: TalonFXSwerve"> <meta name="description" content="declaration: package: swervelib.motors, class: TalonFXSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -50,7 +51,7 @@ loadScripts(document, 'script');</script>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -87,6 +88,42 @@ loadScripts(document, 'script');</script>
<li> <li>
<section class="field-summary" id="field-summary"> <section class="field-summary" id="field-summary">
<h2>Field Summary</h2> <h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
<div class="col-last even-row-color">
<div class="block">Whether the absolute encoder is integrated.</div>
</div>
<div class="col-first odd-row-color"><code>private com.ctre.phoenix6.configs.TalonFXConfiguration</code></div>
<div class="col-second odd-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Current TalonFX configuration.</div>
</div>
<div class="col-first even-row-color"><code>private final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
<div class="col-last even-row-color">
<div class="block">Factory default already occurred.</div>
</div>
<div class="col-first odd-row-color"><code>private final com.ctre.phoenix6.controls.MotionMagicVoltage</code></div>
<div class="col-second odd-row-color"><code><a href="#m_angleVoltageSetter" class="member-name-link">m_angleVoltageSetter</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Motion magic angle voltage setter.</div>
</div>
<div class="col-first even-row-color"><code>private final com.ctre.phoenix6.controls.VelocityVoltage</code></div>
<div class="col-second even-row-color"><code><a href="#m_velocityVoltageSetter" class="member-name-link">m_velocityVoltageSetter</a></code></div>
<div class="col-last even-row-color">
<div class="block">Velocity voltage setter for controlling drive motor.</div>
</div>
<div class="col-first odd-row-color"><code>(package private) com.ctre.phoenix6.hardware.TalonFX</code></div>
<div class="col-second odd-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">TalonFX motor controller.</div>
</div>
</div>
<div class="inherited-list"> <div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class&nbsp;swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3> <h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class&nbsp;swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3>
<code><a href="SwerveMotor.html#isDriveMotor">isDriveMotor</a>, <a href="SwerveMotor.html#maximumRetries">maximumRetries</a></code></div> <code><a href="SwerveMotor.html#isDriveMotor">isDriveMotor</a>, <a href="SwerveMotor.html#maximumRetries">maximumRetries</a></code></div>
@@ -267,6 +304,72 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="factoryDefaultOccurred">
<h3>factoryDefaultOccurred</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">factoryDefaultOccurred</span></div>
<div class="block">Factory default already occurred.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#swervelib.motors.TalonFXSwerve.factoryDefaultOccurred">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="configuration">
<h3>configuration</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">com.ctre.phoenix6.configs.TalonFXConfiguration</span>&nbsp;<span class="element-name">configuration</span></div>
<div class="block">Current TalonFX configuration.</div>
</section>
</li>
<li>
<section class="detail" id="absoluteEncoder">
<h3>absoluteEncoder</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">absoluteEncoder</span></div>
<div class="block">Whether the absolute encoder is integrated.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#swervelib.motors.TalonFXSwerve.absoluteEncoder">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="m_angleVoltageSetter">
<h3>m_angleVoltageSetter</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">com.ctre.phoenix6.controls.MotionMagicVoltage</span>&nbsp;<span class="element-name">m_angleVoltageSetter</span></div>
<div class="block">Motion magic angle voltage setter.</div>
</section>
</li>
<li>
<section class="detail" id="m_velocityVoltageSetter">
<h3>m_velocityVoltageSetter</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">com.ctre.phoenix6.controls.VelocityVoltage</span>&nbsp;<span class="element-name">m_velocityVoltageSetter</span></div>
<div class="block">Velocity voltage setter for controlling drive motor.</div>
</section>
</li>
<li>
<section class="detail" id="motor">
<h3>motor</h3>
<div class="member-signature"><span class="return-type">com.ctre.phoenix6.hardware.TalonFX</span>&nbsp;<span class="element-name">motor</span></div>
<div class="block">TalonFX motor controller.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

125
docs/swervelib/motors/TalonSRXSwerve.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>TalonSRXSwerve (YAGSL-Example API)</title> <title>TalonSRXSwerve</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors, class: TalonSRXSwerve"> <meta name="description" content="declaration: package: swervelib.motors, class: TalonSRXSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -50,7 +51,7 @@ loadScripts(document, 'script');</script>
</ul> </ul>
<ul class="sub-nav-list"> <ul class="sub-nav-list">
<li>Detail:&nbsp;</li> <li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li> <li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li> <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li> <li><a href="#method-detail">Method</a></li>
</ul> </ul>
@@ -87,6 +88,47 @@ loadScripts(document, 'script');</script>
<li> <li>
<section class="field-summary" id="field-summary"> <section class="field-summary" id="field-summary">
<h2>Field Summary</h2> <h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
<div class="col-last even-row-color">
<div class="block">Whether the absolute encoder is integrated.</div>
</div>
<div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#configChanged" class="member-name-link">configChanged</a></code></div>
<div class="col-last odd-row-color">
<div class="block">If the TalonFX configuration has changed.</div>
</div>
<div class="col-first even-row-color"><code>private final com.ctre.phoenix.motorcontrol.can.TalonSRXConfiguration</code></div>
<div class="col-second even-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
<div class="col-last even-row-color">
<div class="block">Current TalonFX configuration.</div>
</div>
<div class="col-first odd-row-color"><code>private final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Factory default already occurred.</div>
</div>
<div class="col-first even-row-color"><code>(package private) com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX</code></div>
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
<div class="col-last even-row-color">
<div class="block">TalonSRX motor controller.</div>
</div>
<div class="col-first odd-row-color"><code>private double</code></div>
<div class="col-second odd-row-color"><code><a href="#nominalVoltage" class="member-name-link">nominalVoltage</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Nominal voltage default to use with feedforward.</div>
</div>
<div class="col-first even-row-color"><code>private double</code></div>
<div class="col-second even-row-color"><code><a href="#positionConversionFactor" class="member-name-link">positionConversionFactor</a></code></div>
<div class="col-last even-row-color">
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
</div>
</div>
<div class="inherited-list"> <div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class&nbsp;swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3> <h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class&nbsp;swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3>
<code><a href="SwerveMotor.html#isDriveMotor">isDriveMotor</a>, <a href="SwerveMotor.html#maximumRetries">maximumRetries</a></code></div> <code><a href="SwerveMotor.html#isDriveMotor">isDriveMotor</a>, <a href="SwerveMotor.html#maximumRetries">maximumRetries</a></code></div>
@@ -267,6 +309,79 @@ loadScripts(document, 'script');</script>
</section> </section>
<section class="details"> <section class="details">
<ul class="details-list"> <ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="factoryDefaultOccurred">
<h3>factoryDefaultOccurred</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">factoryDefaultOccurred</span></div>
<div class="block">Factory default already occurred.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#swervelib.motors.TalonSRXSwerve.factoryDefaultOccurred">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="configuration">
<h3>configuration</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">com.ctre.phoenix.motorcontrol.can.TalonSRXConfiguration</span>&nbsp;<span class="element-name">configuration</span></div>
<div class="block">Current TalonFX configuration.</div>
</section>
</li>
<li>
<section class="detail" id="absoluteEncoder">
<h3>absoluteEncoder</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">absoluteEncoder</span></div>
<div class="block">Whether the absolute encoder is integrated.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#swervelib.motors.TalonSRXSwerve.absoluteEncoder">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="motor">
<h3>motor</h3>
<div class="member-signature"><span class="return-type">com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX</span>&nbsp;<span class="element-name">motor</span></div>
<div class="block">TalonSRX motor controller.</div>
</section>
</li>
<li>
<section class="detail" id="positionConversionFactor">
<h3>positionConversionFactor</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">positionConversionFactor</span></div>
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
</section>
</li>
<li>
<section class="detail" id="configChanged">
<h3>configChanged</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">configChanged</span></div>
<div class="block">If the TalonFX configuration has changed.</div>
</section>
</li>
<li>
<section class="detail" id="nominalVoltage">
<h3>nominalVoltage</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">nominalVoltage</span></div>
<div class="block">Nominal voltage default to use with feedforward.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== --> <!-- ========= CONSTRUCTOR DETAIL ======== -->
<li> <li>
<section class="constructor-details" id="constructor-detail"> <section class="constructor-details" id="constructor-detail">

37
docs/swervelib/motors/package-summary.html
View File

@@ -1,21 +1,26 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.motors (YAGSL-Example API)</title> <title>swervelib.motors</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.motors"> <meta name="description" content="declaration: package: swervelib.motors">
<meta name="generator" content="javadoc/PackageWriterImpl"> <meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-declaration-page"> <body class="package-declaration-page">
<script type="text/javascript">var pathtoroot = "../../"; <script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../";
loadScripts(document, 'script');</script> loadScripts(document, 'script');</script>
<noscript> <noscript>
<div>JavaScript is disabled on your browser.</div> <div>JavaScript is disabled on your browser.</div>
@@ -31,7 +36,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li> <li class="nav-bar-cell1-rev">Package</li>
<li>Class</li> <li>Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#package">Help</a></li> <li><a href="../../help-doc.html#package">Help</a></li>
</ul> </ul>
</div> </div>
@@ -79,22 +84,31 @@ loadScripts(document, 'script');</script>
</li> </li>
<li> <li>
<div id="class-summary"> <div id="class-summary">
<div class="caption"><span>Classes</span></div> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div>
<div class="summary-table two-column-summary"> <div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div> <div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div> <div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></div> <div class="col-first even-row-color class-summary class-summary-tab2"><a href="SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2"> <div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">An implementation of <code>CANSparkFlex</code> as a <a href="SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div> <div class="block">An implementation of <code>CANSparkFlex</code> as a <a href="SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</div> </div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div> <div class="col-first odd-row-color class-summary class-summary-tab3"><a href="SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2"> <div class="col-last odd-row-color class-summary class-summary-tab3">
<div class="block">REV Slots for PID configuration.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Brushed motor control with SparkMax.</div> <div class="block">Brushed motor control with SparkMax.</div>
</div> </div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div> <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2"> <div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div> <div class="block">An implementation of <code>CANSparkMax</code> as a <a href="SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
</div> </div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">REV Slots for PID configuration.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div> <div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2"> <div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div> <div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
@@ -109,6 +123,7 @@ loadScripts(document, 'script');</script>
</div> </div>
</div> </div>
</div> </div>
</div>
</li> </li>
</ul> </ul>
</section> </section>

24
docs/swervelib/motors/package-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.motors Class Hierarchy (YAGSL-Example API)</title> <title>swervelib.motors Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="tree: package: swervelib.motors"> <meta name="description" content="tree: package: swervelib.motors">
<meta name="generator" content="javadoc/PackageTreeWriter"> <meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-tree-page"> <body class="package-tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#tree">Help</a></li> <li><a href="../../help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>
@@ -71,6 +72,21 @@ loadScripts(document, 'script');</script>
</li> </li>
</ul> </ul>
</section> </section>
<section class="hierarchy">
<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2>
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
<ul>
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a>&lt;E&gt; (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;T&gt;, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
<ul>
<li class="circle">swervelib.motors.<a href="SparkFlexSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></li>
<li class="circle">swervelib.motors.<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
</main> </main>
</div> </div>
</div> </div>

9
docs/swervelib/package-summary.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib (YAGSL-Example API)</title> <title>swervelib</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib"> <meta name="description" content="declaration: package: swervelib">
<meta name="generator" content="javadoc/PackageWriterImpl"> <meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script> <script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-declaration-page"> <body class="package-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li> <li class="nav-bar-cell1-rev">Package</li>
<li>Class</li> <li>Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../index-all.html">Index</a></li> <li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html#package">Help</a></li> <li><a href="../help-doc.html#package">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/package-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib Class Hierarchy (YAGSL-Example API)</title> <title>swervelib Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="tree: package: swervelib"> <meta name="description" content="tree: package: swervelib">
<meta name="generator" content="javadoc/PackageTreeWriter"> <meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script> <script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-tree-page"> <body class="package-tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="../index-all.html">Index</a></li> <li><a href="../index-files/index-1.html">Index</a></li>
<li><a href="../help-doc.html#tree">Help</a></li> <li><a href="../help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/PIDFConfig.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>PIDFConfig (YAGSL-Example API)</title> <title>PIDFConfig</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser, class: PIDFConfig"> <meta name="description" content="declaration: package: swervelib.parser, class: PIDFConfig">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/SwerveControllerConfiguration.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveControllerConfiguration (YAGSL-Example API)</title> <title>SwerveControllerConfiguration</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveControllerConfiguration"> <meta name="description" content="declaration: package: swervelib.parser, class: SwerveControllerConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/SwerveDriveConfiguration.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveDriveConfiguration (YAGSL-Example API)</title> <title>SwerveDriveConfiguration</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveDriveConfiguration"> <meta name="description" content="declaration: package: swervelib.parser, class: SwerveDriveConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/SwerveModuleConfiguration.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveModuleConfiguration (YAGSL-Example API)</title> <title>SwerveModuleConfiguration</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModuleConfiguration"> <meta name="description" content="declaration: package: swervelib.parser, class: SwerveModuleConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/SwerveModulePhysicalCharacteristics.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveModulePhysicalCharacteristics (YAGSL-Example API)</title> <title>SwerveModulePhysicalCharacteristics</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModulePhysicalCharacteristics"> <meta name="description" content="declaration: package: swervelib.parser, class: SwerveModulePhysicalCharacteristics">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

103
docs/swervelib/parser/SwerveParser.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>SwerveParser (YAGSL-Example API)</title> <title>SwerveParser</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveParser"> <meta name="description" content="declaration: package: swervelib.parser, class: SwerveParser">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script> <script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-all.html">Index</a></li> <li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li> <li><a href="../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>
@@ -95,24 +96,29 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color"> <div class="col-last even-row-color">
<div class="block">Parsed controllerproperties.json</div> <div class="block">Parsed controllerproperties.json</div>
</div> </div>
<div class="col-first odd-row-color"><code>static <a href="json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a>[]</code></div> <div class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</code></div>
<div class="col-second odd-row-color"><code><a href="#moduleJsons" class="member-name-link">moduleJsons</a></code></div> <div class="col-second odd-row-color"><code><a href="#moduleConfigs" class="member-name-link">moduleConfigs</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last odd-row-color">
<div class="block">Module number mapped to the JSON name.</div>
</div>
<div class="col-first even-row-color"><code>static <a href="json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a>[]</code></div>
<div class="col-second even-row-color"><code><a href="#moduleJsons" class="member-name-link">moduleJsons</a></code></div>
<div class="col-last even-row-color">
<div class="block">Array holding the module jsons given in <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json"><code>SwerveDriveJson</code></a>.</div> <div class="block">Array holding the module jsons given in <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json"><code>SwerveDriveJson</code></a>.</div>
</div> </div>
<div class="col-first even-row-color"><code>static <a href="json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></code></div> <div class="col-first odd-row-color"><code>static <a href="json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></code></div>
<div class="col-second even-row-color"><code><a href="#physicalPropertiesJson" class="member-name-link">physicalPropertiesJson</a></code></div> <div class="col-second odd-row-color"><code><a href="#physicalPropertiesJson" class="member-name-link">physicalPropertiesJson</a></code></div>
<div class="col-last even-row-color"> <div class="col-last odd-row-color">
<div class="block">Parsed modules/physicalproperties.json</div> <div class="block">Parsed modules/physicalproperties.json</div>
</div> </div>
<div class="col-first odd-row-color"><code>static <a href="json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></code></div> <div class="col-first even-row-color"><code>static <a href="json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></code></div>
<div class="col-second odd-row-color"><code><a href="#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a></code></div> <div class="col-second even-row-color"><code><a href="#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a></code></div>
<div class="col-last odd-row-color"> <div class="col-last even-row-color">
<div class="block">Parsed modules/pidfproperties.json</div> <div class="block">Parsed modules/pidfproperties.json</div>
</div> </div>
<div class="col-first even-row-color"><code>static <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></code></div> <div class="col-first odd-row-color"><code>static <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></code></div>
<div class="col-second even-row-color"><code><a href="#swerveDriveJson" class="member-name-link">swerveDriveJson</a></code></div> <div class="col-second odd-row-color"><code><a href="#swerveDriveJson" class="member-name-link">swerveDriveJson</a></code></div>
<div class="col-last even-row-color"> <div class="col-last odd-row-color">
<div class="block">Parsed swervedrive.json</div> <div class="block">Parsed swervedrive.json</div>
</div> </div>
</div> </div>
@@ -144,38 +150,48 @@ loadScripts(document, 'script');</script>
<div class="table-header col-first">Modifier and Type</div> <div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div> <div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div> <div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(double)" class="member-name-link">createSwerveDrive</a><wbr>(double&nbsp;maxSpeed)</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkDirectory(java.io.File)" class="member-name-link">checkDirectory</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;directory)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div> <div class="block">Check directory structure.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(double,double,double)" class="member-name-link">createSwerveDrive</a><wbr>(double&nbsp;maxSpeed, <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(double)" class="member-name-link">createSwerveDrive</a><wbr>(double&nbsp;maxSpeed)</code></div>
double&nbsp;angleMotorConversionFactor,
double&nbsp;driveMotorConversion)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div> <div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)" class="member-name-link">createSwerveDrive</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward, <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(double,double,double)" class="member-name-link">createSwerveDrive</a><wbr>(double&nbsp;maxSpeed,
double&nbsp;maxSpeed)</code></div> double&nbsp;angleMotorConversionFactor,
double&nbsp;driveMotorConversion)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div> <div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</div> </div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)" class="member-name-link">createSwerveDrive</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward, <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)" class="member-name-link">createSwerveDrive</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
double&nbsp;maxSpeed)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)" class="member-name-link">createSwerveDrive</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
double&nbsp;maxSpeed, double&nbsp;maxSpeed,
double&nbsp;angleMotorConversionFactor, double&nbsp;angleMotorConversionFactor,
double&nbsp;driveMotorConversion)</code></div> double&nbsp;driveMotorConversion)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div> <div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a></code></div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name, <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
<a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;driveConfiguration)</code></div> <a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;driveConfiguration)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Get the swerve module by the json name.</div> <div class="block">Get the swerve module by the json name.</div>
</div> </div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private com.fasterxml.jackson.databind.JsonNode</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openJson(java.io.File)" class="member-name-link">openJson</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;file)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Open JSON file.</div>
</div>
</div> </div>
</div> </div>
</div> </div>
@@ -194,6 +210,13 @@ loadScripts(document, 'script');</script>
<h2>Field Details</h2> <h2>Field Details</h2>
<ul class="member-list"> <ul class="member-list">
<li> <li>
<section class="detail" id="moduleConfigs">
<h3>moduleConfigs</h3>
<div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</span>&nbsp;<span class="element-name">moduleConfigs</span></div>
<div class="block">Module number mapped to the JSON name.</div>
</section>
</li>
<li>
<section class="detail" id="swerveDriveJson"> <section class="detail" id="swerveDriveJson">
<h3>swerveDriveJson</h3> <h3>swerveDriveJson</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></span>&nbsp;<span class="element-name">swerveDriveJson</span></div> <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></span>&nbsp;<span class="element-name">swerveDriveJson</span></div>
@@ -274,6 +297,30 @@ loadScripts(document, 'script');</script>
</section> </section>
</li> </li>
<li> <li>
<section class="detail" id="openJson(java.io.File)">
<h3>openJson</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">com.fasterxml.jackson.databind.JsonNode</span>&nbsp;<span class="element-name">openJson</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;file)</span></div>
<div class="block">Open JSON file.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>file</code> - JSON File to open.</dd>
<dt>Returns:</dt>
<dd>JsonNode of file.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="checkDirectory(java.io.File)">
<h3>checkDirectory</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">checkDirectory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;directory)</span></div>
<div class="block">Check directory structure.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>directory</code> - JSON Configuration Directory</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createSwerveDrive(double)"> <section class="detail" id="createSwerveDrive(double)">
<h3>createSwerveDrive</h3> <h3>createSwerveDrive</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span><wbr><span class="parameters">(double&nbsp;maxSpeed)</span></div> <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span><wbr><span class="parameters">(double&nbsp;maxSpeed)</span></div>

9
docs/swervelib/parser/deserializer/PIDFRange.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>PIDFRange (YAGSL-Example API)</title> <title>PIDFRange</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser.deserializer, class: PIDFRange"> <meta name="description" content="declaration: package: swervelib.parser.deserializer, class: PIDFRange">
<meta name="generator" content="javadoc/ClassWriterImpl"> <meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="class-declaration-page"> <body class="class-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li> <li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li> <li><a href="../../../help-doc.html#class">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/deserializer/package-summary.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.parser.deserializer (YAGSL-Example API)</title> <title>swervelib.parser.deserializer</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="declaration: package: swervelib.parser.deserializer"> <meta name="description" content="declaration: package: swervelib.parser.deserializer">
<meta name="generator" content="javadoc/PackageWriterImpl"> <meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-declaration-page"> <body class="package-declaration-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li class="nav-bar-cell1-rev">Package</li> <li class="nav-bar-cell1-rev">Package</li>
<li>Class</li> <li>Class</li>
<li><a href="package-tree.html">Tree</a></li> <li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html#package">Help</a></li> <li><a href="../../../help-doc.html#package">Help</a></li>
</ul> </ul>
</div> </div>

9
docs/swervelib/parser/deserializer/package-tree.html
View File

@@ -1,17 +1,18 @@
<!DOCTYPE HTML> <!DOCTYPE HTML>
<html lang="en"> <html lang="en">
<head> <head>
<!-- Generated by javadoc (17) --> <!-- Generated by javadoc (17) on Mon Jan 15 14:38:31 CST 2024 -->
<title>swervelib.parser.deserializer Class Hierarchy (YAGSL-Example API)</title> <title>swervelib.parser.deserializer Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-15">
<meta name="description" content="tree: package: swervelib.parser.deserializer"> <meta name="description" content="tree: package: swervelib.parser.deserializer">
<meta name="generator" content="javadoc/PackageTreeWriter"> <meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style"> <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script> <script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.0.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script> <script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head> </head>
<body class="package-tree-page"> <body class="package-tree-page">
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li> <li><a href="package-summary.html">Package</a></li>
<li>Class</li> <li>Class</li>
<li class="nav-bar-cell1-rev">Tree</li> <li class="nav-bar-cell1-rev">Tree</li>
<li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html#tree">Help</a></li> <li><a href="../../../help-doc.html#tree">Help</a></li>
</ul> </ul>
</div> </div>

Some files were not shown because too many files have changed in this diff Show More