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 docs

Browse Source
This commit is contained in:
thenetworkgrinch
2023-02-13 15:03:55 -06:00
parent 9f8c3f6b49
commit e8d248b68a
161 changed files with 2589 additions and 37454 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/allclasses-index.html
View File

@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 14:36:54 CST 2023 -->
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 15:03:24 CST 2023 -->
<title>All Classes</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
@@ -112,203 +112,200 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/BoolMotorJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules">BoolMotorJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></td>
<th class="colLast" scope="row">
<div class="block">Inverted motor JSON parsed class.</div>
</th>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/encoders/CANCoderSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.encoders">CANCoderSwerve</a></td>
<td class="colFirst"><a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
</th>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/ControllerPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">ControllerPropertiesJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveController.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/DeviceJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">DeviceJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></td>
<th class="colLast" scope="row">
<div class="block">Device JSON parsed class.</div>
</th>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/LocationJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules">LocationJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></td>
<th class="colLast" scope="row">
<div class="block">Location JSON parsed class.</div>
</th>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/ModuleJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">ModuleJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigDouble.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">MotorConfigDouble</a></td>
<td class="colFirst"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></td>
<th class="colLast" scope="row">
<div class="block">Used to store doubles for motor configuration.</div>
</th>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigInt.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">MotorConfigInt</a></td>
<td class="colFirst"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></td>
<th class="colLast" scope="row">
<div class="block">Used to store ints for motor configuration.</div>
</th>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/imu/NavXSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">NavXSwerve</a></td>
<td class="colFirst"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">Communicates with the NavX as the IMU.</div>
</th>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/PhysicalPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">PhysicalPropertiesJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">PIDFConfig</a></td>
<td class="colFirst"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></td>
<th class="colLast" scope="row">
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
</th>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/PIDFPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">PIDFPropertiesJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/PIDFRange.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer">PIDFRange</a></td>
<td class="colFirst"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></td>
<th class="colLast" scope="row">
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
</th>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">Pigeon2Swerve</a></td>
<td class="colFirst"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></td>
<th class="colLast" scope="row">
<div class="block">SwerveIMU interface for the Pigeon2</div>
</th>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">PigeonSwerve</a></td>
<td class="colFirst"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">SwerveIMU interface for the Pigeon.</div>
</th>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.encoders">SparkMaxEncoderSwerve</a></td>
<td class="colFirst"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
</th>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SparkMaxSwerve</a></td>
<td class="colFirst"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></td>
<th class="colLast" scope="row">
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive2.swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></td>
<td class="colFirst"><a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></td>
<th class="colLast" scope="row">
<div class="block">REV Slots for PID configuration.</div>
</th>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.encoders">SwerveAbsoluteEncoder</a></td>
<td class="colFirst"><a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
</th>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveController.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveController</a></td>
<td class="colFirst"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></td>
<th class="colLast" scope="row">
<div class="block">Controller class used to convert raw inputs into robot speeds.</div>
</th>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveControllerConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveControllerConfiguration</a></td>
<td class="colFirst"><a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Controller configuration class which is used to configure
<a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveController.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveDrive</a></td>
<td class="colFirst"><a href="swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
</th>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveDriveConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveDriveConfiguration</a></td>
<td class="colFirst"><a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
</th>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/json/SwerveDriveJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">SwerveDriveJson</a></td>
<td class="colFirst"><a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></td>
<th class="colLast" scope="row">
<div class="block"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/imu/SwerveIMU.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">SwerveIMU</a></td>
<td class="colFirst"><a href="swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
</th>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/math/SwerveKinematics2.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math">SwerveKinematics2</a></td>
<td class="colFirst"><a href="swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></td>
<th class="colLast" scope="row">
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
speed.</div>
</th>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/math/SwerveMath.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math">SwerveMath</a></td>
<td class="colFirst"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></td>
<th class="colLast" scope="row">
<div class="block">Mathematical functions which pertain to swerve drive.</div>
</th>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveModule</a></td>
<td class="colFirst"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></td>
<th class="colLast" scope="row">
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</th>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModuleConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModuleConfiguration</a></td>
<td class="colFirst"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve Module configuration class which is used to configure
<a href="frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.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>
</th>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModulePhysicalCharacteristics</a></td>
<td class="colFirst"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></td>
<th class="colLast" scope="row">
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</th>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/math/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math">SwerveModuleState2</a></td>
<td class="colFirst"><a href="swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></td>
<th class="colLast" scope="row">
<div class="block">Second order kinematics swerve module state.</div>
</th>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SwerveMotor</a></td>
<td class="colFirst"><a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></td>
<th class="colLast" scope="row">
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
</th>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><a href="frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveParser</a></td>
<td class="colFirst"><a href="swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></td>
<th class="colLast" scope="row">
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
</th>