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
2024-01-17 09:18:38 -06:00
parent 1ca3db242c
commit 889c85172f
108 changed files with 1609 additions and 370 deletions
Download Patch File Download Diff File Expand all files Collapse all files

212
docs/allclasses-index.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>All Classes and Interfaces</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2024-01-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="class index">
<meta name="generator" content="javadoc/AllClassesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -72,189 +72,199 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">IMU Swerve class for the <code>ADXRS450_Gyro</code> device.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Class for managing persistent alerts to be sent over NetworkTables.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Represents an alert's level of urgency.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</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/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="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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 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-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Inverted motor JSON parsed class.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">HELIUM <code>Canandcoder</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
</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-first odd-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 odd-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>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Device JSON parsed class.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Location JSON parsed class.</div>
</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-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>
<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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
</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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block">Used to store doubles for motor configuration.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block">Used to store ints for motor configuration.</div>
</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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">Communicates with the NavX as the IMU.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
</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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block">Hold the PIDF and Integral Zone values for a PID.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="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 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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">SwerveIMU interface for the Pigeon2</div>
</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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">SwerveIMU interface for the Pigeon.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="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>
</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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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>
<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-first odd-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 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/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Brushed motor control with SparkMax.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div>
<div class="col-last odd-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>
<div class="col-first even-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 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/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div>
<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>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Brushed motor control with SparkMax.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></div>
<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.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div>
<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>
<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-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>
<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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">Controller class used to convert raw inputs into robot speeds.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="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 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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">Swerve Drive class representing and controlling the swerve drive.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block">Swerve drive configurations used during SwerveDrive construction.</div>
</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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block"><a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="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 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 odd-row-color all-classes-table all-classes-table-tab3">
<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-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Verbosity of telemetry data sent back.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="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-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Simulation for <a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Mathematical functions which pertain to swerve drive.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Swerve Module configuration class which is used to configure <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</div>
<div class="col-first 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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Class to hold simulation data for <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
</div>
<div class="col-first 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 odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/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="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
</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 even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/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="block">Helper class used to parse the JSON directory with specified configuration options.</div>
</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-first even-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 even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
</div>
</div>

4
docs/allpackages-index.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>All Packages</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
docs/constant-values.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>Constant Field Values</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="summary of constants">
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

4
docs/help-doc.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>API Help</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="help">
<meta name="generator" content="javadoc/HelpWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

34
docs/index-files/index-1.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: A">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -93,6 +93,14 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Absolute encoder offset from 0 in degrees.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#absoluteEncoderOffsetWarning" class="member-name-link">absoluteEncoderOffsetWarning</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder's offset is set in the json instead of the hardware client.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html#active" class="member-name-link">active</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/telemetry/Alert.html#activeStartTime" class="member-name-link">activeStartTime</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>&nbsp;</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>
@@ -131,6 +139,28 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Construct the ADXRS450 imu and reset default configurations.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html" class="type-name-link" title="class in swervelib.telemetry">Alert</a> - Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
<dd>
<div class="block">Class for managing persistent alerts to be sent over NetworkTables.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html#%3Cinit%3E(java.lang.String,java.lang.String,swervelib.telemetry.Alert.AlertType)" class="member-name-link">Alert(String, String, Alert.AlertType)</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>
<div class="block">Creates a new Alert.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html#%3Cinit%3E(java.lang.String,swervelib.telemetry.Alert.AlertType)" class="member-name-link">Alert(String, Alert.AlertType)</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>
<div class="block">Creates a new Alert in the default group - "Alerts".</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html" class="type-name-link" title="enum class in swervelib.telemetry">Alert.AlertType</a> - Enum Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
<dd>
<div class="block">Represents an alert's level of urgency.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html" class="type-name-link" title="class in swervelib.telemetry">Alert.SendableAlerts</a> - Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html#alerts" class="member-name-link">alerts</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#%3Cinit%3E()" class="member-name-link">AlertType()</a> - Constructor for enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
<dd>&nbsp;</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>

4
docs/index-files/index-10.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: K">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
docs/index-files/index-11.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: L">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

8
docs/index-files/index-12.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: M">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -65,6 +65,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Only send the machine readable data related to swerve drive.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#magnetFieldLessThanIdeal" class="member-name-link">magnetFieldLessThanIdeal</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</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>

20
docs/index-files/index-13.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: N">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -57,6 +57,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Name for the swerve module for telemetry.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#navXError" class="member-name-link">navXError</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error instantiating the NavX.</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>
@@ -73,6 +77,18 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Constructor for the NavX swerve.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#noEncoderAlert" class="member-name-link">noEncoderAlert</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#noEncoderDefinedAlert" class="member-name-link">noEncoderDefinedAlert</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder defined.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#noEncoderWarning" class="member-name-link">noEncoderWarning</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</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>

8
docs/index-files/index-14.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: O">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -89,6 +89,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Offset for the Pigeon.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#offsetFailure" class="member-name-link">offsetFailure</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder offset.</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>

4
docs/index-files/index-15.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: P">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
docs/index-files/index-16.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: Q">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

12
docs/index-files/index-17.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: R">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -61,6 +61,14 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Last angle reading was faulty.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#readingFaulty" class="member-name-link">readingFaulty</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#readingIgnored" class="member-name-link">readingIgnored</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</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>

14
docs/index-files/index-18.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: S">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -53,6 +53,12 @@ loadScripts(document, 'script');</script>
<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/telemetry/Alert.SendableAlerts.html#%3Cinit%3E()" class="member-name-link">SendableAlerts()</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/telemetry/Alert.html#set(boolean)" class="member-name-link">set(boolean)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>
<div class="block">Sets whether the alert should currently be displayed.</div>
</dd>
<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>
@@ -427,6 +433,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the closed loop PID controller reference point.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html#setText(java.lang.String)" class="member-name-link">setText(String)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>
<div class="block">Updates current alert text.</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>

8
docs/index-files/index-19.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: T">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -83,6 +83,8 @@ loadScripts(document, 'script');</script>
</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/telemetry/Alert.html#text" class="member-name-link">text</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</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>
@@ -99,6 +101,8 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The device type, e.g.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html#type" class="member-name-link">type</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>&nbsp;</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>

4
docs/index-files/index-2.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: B">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
docs/index-files/index-20.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: U">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

13
docs/index-files/index-21.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: V">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -61,6 +61,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</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>
@@ -75,6 +79,11 @@ the order they are declared.</div>
<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/Alert.AlertType.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</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

12
docs/index-files/index-22.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: W">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -53,6 +53,14 @@ loadScripts(document, 'script');</script>
<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/telemetry/Alert.AlertType.html#WARNING" class="member-name-link">WARNING</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
<dd>
<div class="block">Medium priority alert - displayed second on the dashboard with a yellow "!" symbol.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#WARNING_TRACE" class="member-name-link">WARNING_TRACE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
<dd>
<div class="block">Medium priority alert - displayed second on the dashboard with a yellow "!" symbol.</div>
</dd>
<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>

4
docs/index-files/index-23.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: X">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
docs/index-files/index-24.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: Y">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

4
docs/index-files/index-25.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: Z">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

16
docs/index-files/index-3.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: C">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -101,6 +101,18 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Initialize the CANCoder on the CANivore.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#canIdWarning" class="member-name-link">canIdWarning</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">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CAN ID is greater than 40.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#cannotSetOffset" class="member-name-link">cannotSetOffset</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</dd>
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#cannotSetOffset" class="member-name-link">cannotSetOffset</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</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

8
docs/index-files/index-4.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: D">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -71,6 +71,10 @@ loadScripts(document, 'script');</script>
</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/encoders/SparkMaxAnalogEncoderSwerve.html#doesNotSupportIntegratedOffsets" class="member-name-link">doesNotSupportIntegratedOffsets</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder does not support integrated offsets.</div>
</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>

16
docs/index-files/index-5.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: E">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -93,6 +93,18 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Absolute encoder device configuration.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#encoderOffsetWarning" class="member-name-link">encoderOffsetWarning</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#ERROR" class="member-name-link">ERROR</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
<dd>
<div class="block">High priority alert - displayed first on the dashboard with a red "X" symbol.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#ERROR_TRACE" class="member-name-link">ERROR_TRACE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
<dd>
<div class="block">High priority alert - displayed first on the dashboard with a red "X" symbol.</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>

20
docs/index-files/index-6.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: F">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -161,6 +161,22 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Configure the factory defaults.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#failureConfiguring" class="member-name-link">failureConfiguring</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#failureConfiguring" class="member-name-link">failureConfiguring</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
</dd>
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#failureConfiguring" class="member-name-link">failureConfiguring</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#failureConfiguringAlert" class="member-name-link">failureConfiguringAlert</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</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>

8
docs/index-files/index-7.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: G">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -401,6 +401,8 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Gets the current module states (azimuth and velocity)</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html#getStrings(swervelib.telemetry.Alert.AlertType)" class="member-name-link">getStrings(Alert.AlertType)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
<dd>&nbsp;</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
@@ -487,6 +489,8 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.html#groups" class="member-name-link">groups</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
<dd>&nbsp;</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>

4
docs/index-files/index-8.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: H">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

22
docs/index-files/index-9.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index: I">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -57,6 +57,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Integral Gain for PID.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#i2cLockupWarning" class="member-name-link">i2cLockupWarning</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">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an I2C lockup issue on the roboRIO.</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>
@@ -93,6 +97,20 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> detailing how the analog absolute encoder may not report accurate velocities.</div>
</dd>
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
<dd>
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the encoder cannot report accurate velocities.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#INFO" class="member-name-link">INFO</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
<dd>
<div class="block">Low priority alert - displayed last on the dashboard with a green "i" symbol.</div>
</dd>
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html#initSendable(edu.wpi.first.util.sendable.SendableBuilder)" class="member-name-link">initSendable(SendableBuilder)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
<dd>&nbsp;</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>

4
docs/index.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>Overview</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="package index">
<meta name="generator" content="javadoc/PackageIndexWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

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

File diff suppressed because one or more lines are too long

4
docs/overview-summary.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>Generated Documentation (Untitled)</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="index redirect">
<meta name="generator" content="javadoc/IndexRedirectWriter">
<link rel="canonical" href="index.html">

7
docs/overview-tree.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="class tree">
<meta name="generator" content="javadoc/TreeWriter">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -69,6 +69,8 @@ loadScripts(document, 'script');</script>
<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">swervelib.telemetry.<a href="swervelib/telemetry/Alert.html" class="type-name-link" title="class in swervelib.telemetry">Alert</a></li>
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/Alert.SendableAlerts.html" class="type-name-link" title="class in swervelib.telemetry">Alert.SendableAlerts</a> (implements edu.wpi.first.util.sendable.Sendable)</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">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>
@@ -135,6 +137,7 @@ loadScripts(document, 'script');</script>
<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.telemetry.<a href="swervelib/telemetry/Alert.AlertType.html" class="type-name-link" title="enum class in swervelib.telemetry">Alert.AlertType</a></li>
<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>

4
docs/swervelib/SwerveController.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveController</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib, class: SwerveController">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

48
docs/swervelib/SwerveDrive.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveDrive</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib, class: SwerveDrive">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -554,6 +554,21 @@ loadScripts(document, 'script');</script>
</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="field">
<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>
@@ -601,13 +616,6 @@ loadScripts(document, 'script');</script>
</section>
</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">
<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>
@@ -615,6 +623,13 @@ loadScripts(document, 'script');</script>
</section>
</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="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>
@@ -636,21 +651,6 @@ loadScripts(document, 'script');</script>
</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>

50
docs/swervelib/SwerveModule.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveModule</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib, class: SwerveModule">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -116,26 +116,36 @@ loadScripts(document, 'script');</script>
<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-second odd-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div>
<div class="col-first odd-row-color"><code>private final <a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#encoderOffsetWarning" class="member-name-link">encoderOffsetWarning</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
</div>
<div class="col-first even-row-color"><code>edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
<div class="col-second even-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div>
<div class="col-last even-row-color">
<div class="block">Feedforward for drive motor during closed loop control.</div>
</div>
<div class="col-first even-row-color"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
<div class="col-second even-row-color"><code><a href="#lastState" class="member-name-link">lastState</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
<div class="col-second odd-row-color"><code><a href="#lastState" class="member-name-link">lastState</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Last swerve module state applied.</div>
</div>
<div class="col-first odd-row-color"><code>double</code></div>
<div class="col-second odd-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
<div class="col-last even-row-color">
<div class="block">Maximum speed of the drive motors in meters per second.</div>
</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#moduleNumber" class="member-name-link">moduleNumber</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>int</code></div>
<div class="col-second odd-row-color"><code><a href="#moduleNumber" class="member-name-link">moduleNumber</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Module number for kinematics, usually 0 to 3.</div>
</div>
<div class="col-first even-row-color"><code>private final <a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#noEncoderWarning" class="member-name-link">noEncoderWarning</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</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">
@@ -320,6 +330,20 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="encoderOffsetWarning">
<h3>encoderOffsetWarning</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">encoderOffsetWarning</span></div>
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
</section>
</li>
<li>
<section class="detail" id="noEncoderWarning">
<h3>noEncoderWarning</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">noEncoderWarning</span></div>
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</div>
</section>
</li>
<li>
<section class="detail" id="moduleNumber">
<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>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>AnalogAbsoluteEncoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: AnalogAbsoluteEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -93,11 +93,21 @@ loadScripts(document, 'script');</script>
<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>edu.wpi.first.wpilibj.AnalogInput</code></div>
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#cannotSetOffset" class="member-name-link">cannotSetOffset</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</div>
<div class="col-first odd-row-color"><code>edu.wpi.first.wpilibj.AnalogInput</code></div>
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Encoder as Analog Input.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> detailing how the analog absolute encoder may not report accurate velocities.</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">
@@ -205,6 +215,20 @@ loadScripts(document, 'script');</script>
<div class="block">Inversion state of the encoder.</div>
</section>
</li>
<li>
<section class="detail" id="cannotSetOffset">
<h3>cannotSetOffset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">cannotSetOffset</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</section>
</li>
<li>
<section class="detail" id="inaccurateVelocities">
<h3>inaccurateVelocities</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">inaccurateVelocities</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> detailing how the analog absolute encoder may not report accurate velocities.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>CANCoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: CANCoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -93,11 +93,31 @@ loadScripts(document, 'script');</script>
<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>com.ctre.phoenix6.hardware.CANcoder</code></div>
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#cannotSetOffset" class="member-name-link">cannotSetOffset</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</div>
<div class="col-first odd-row-color"><code>com.ctre.phoenix6.hardware.CANcoder</code></div>
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-last odd-row-color">
<div class="block">CANCoder with WPILib sendable and support.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#magnetFieldLessThanIdeal" class="member-name-link">magnetFieldLessThanIdeal</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</div>
</div>
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#readingFaulty" class="member-name-link">readingFaulty</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#readingIgnored" class="member-name-link">readingIgnored</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</div>
</div>
</div>
<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>
@@ -194,6 +214,34 @@ loadScripts(document, 'script');</script>
<div class="block">CANCoder with WPILib sendable and support.</div>
</section>
</li>
<li>
<section class="detail" id="magnetFieldLessThanIdeal">
<h3>magnetFieldLessThanIdeal</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">magnetFieldLessThanIdeal</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</div>
</section>
</li>
<li>
<section class="detail" id="readingFaulty">
<h3>readingFaulty</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">readingFaulty</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
</section>
</li>
<li>
<section class="detail" id="readingIgnored">
<h3>readingIgnored</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">readingIgnored</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</div>
</section>
</li>
<li>
<section class="detail" id="cannotSetOffset">
<h3>cannotSetOffset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">cannotSetOffset</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>CanAndCoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: CanAndCoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -221,7 +221,7 @@ loadScripts(document, 'script');</script>
<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="block">Reset the encoder to factory defaults.
<p>
This will not clear the stored zero offset.</div>
<dl class="notes">
<dt>Specified by:</dt>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>PWMDutyCycleEncoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: PWMDutyCycleEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -103,9 +103,14 @@ loadScripts(document, 'script');</script>
<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-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the encoder cannot report accurate velocities.</div>
</div>
<div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#isInverted" class="member-name-link">isInverted</a></code></div>
<div class="col-last even-row-color">
<div class="block">Inversion state.</div>
</div>
</div>
@@ -206,6 +211,13 @@ loadScripts(document, 'script');</script>
<div class="block">Inversion state.</div>
</section>
</li>
<li>
<section class="detail" id="inaccurateVelocities">
<h3>inaccurateVelocities</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">inaccurateVelocities</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the encoder cannot report accurate velocities.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SparkMaxAnalogEncoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxAnalogEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -93,11 +93,21 @@ loadScripts(document, 'script');</script>
<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>com.revrobotics.SparkAnalogSensor</code></div>
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#doesNotSupportIntegratedOffsets" class="member-name-link">doesNotSupportIntegratedOffsets</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder does not support integrated offsets.</div>
</div>
<div class="col-first odd-row-color"><code>com.revrobotics.SparkAnalogSensor</code></div>
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The <code>SparkAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#failureConfiguring" class="member-name-link">failureConfiguring</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
</div>
</div>
<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>
@@ -195,6 +205,20 @@ loadScripts(document, 'script');</script>
<div class="block">The <code>SparkAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
</section>
</li>
<li>
<section class="detail" id="failureConfiguring">
<h3>failureConfiguring</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">failureConfiguring</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
</section>
</li>
<li>
<section class="detail" id="doesNotSupportIntegratedOffsets">
<h3>doesNotSupportIntegratedOffsets</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">doesNotSupportIntegratedOffsets</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder does not support integrated offsets.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SparkMaxEncoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -98,6 +98,16 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color">
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
</div>
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#failureConfiguring" class="member-name-link">failureConfiguring</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#offsetFailure" class="member-name-link">offsetFailure</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder offset.</div>
</div>
</div>
<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>
@@ -195,6 +205,20 @@ loadScripts(document, 'script');</script>
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
</section>
</li>
<li>
<section class="detail" id="failureConfiguring">
<h3>failureConfiguring</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">failureConfiguring</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
</section>
</li>
<li>
<section class="detail" id="offsetFailure">
<h3>offsetFailure</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">offsetFailure</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder offset.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveAbsoluteEncoder</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: SwerveAbsoluteEncoder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.encoders</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.encoders Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.encoders">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>ADIS16448Swerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: ADIS16448Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>ADIS16470Swerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: ADIS16470Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>ADXRS450Swerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: ADXRS450Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>AnalogGyroSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: AnalogGyroSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>NavXSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: NavXSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -98,9 +98,14 @@ loadScripts(document, 'script');</script>
<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-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#navXError" class="member-name-link">navXError</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error instantiating the NavX.</div>
</div>
<div class="col-first even-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
<div class="col-second even-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
<div class="col-last even-row-color">
<div class="block">Offset for the NavX.</div>
</div>
</div>
@@ -206,6 +211,13 @@ loadScripts(document, 'script');</script>
<div class="block">Offset for the NavX.</div>
</section>
</li>
<li>
<section class="detail" id="navXError">
<h3>navXError</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">navXError</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error instantiating the NavX.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>Pigeon2Swerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: Pigeon2Swerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>PigeonSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: PigeonSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveIMU</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu, class: SwerveIMU">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.imu</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.imu">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.imu Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.imu">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>Matter</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.math, class: Matter">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveMath</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.math, class: SwerveMath">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.math</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.math">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.math Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.math">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

4
docs/swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<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">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SparkFlexSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkFlexSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -115,16 +115,26 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color">
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
</div>
<div class="col-first odd-row-color"><code>com.revrobotics.RelativeEncoder</code></div>
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#absoluteEncoderOffsetWarning" class="member-name-link">absoluteEncoderOffsetWarning</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder's offset is set in the json instead of the hardware client.</div>
</div>
<div class="col-first even-row-color"><code>com.revrobotics.RelativeEncoder</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">Integrated encoder.</div>
</div>
<div class="col-first even-row-color"><code>private 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="col-first odd-row-color"><code>private 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>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#failureConfiguring" class="member-name-link">failureConfiguring</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</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">
@@ -344,6 +354,20 @@ loadScripts(document, 'script');</script>
<div class="block">Factory default already occurred.</div>
</section>
</li>
<li>
<section class="detail" id="failureConfiguring">
<h3>failureConfiguring</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">failureConfiguring</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</div>
</section>
</li>
<li>
<section class="detail" id="absoluteEncoderOffsetWarning">
<h3>absoluteEncoderOffsetWarning</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">absoluteEncoderOffsetWarning</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder's offset is set in the json instead of the hardware client.</div>
</section>
</li>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SparkMaxBrushedMotorSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxBrushedMotorSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -108,14 +108,29 @@ loadScripts(document, 'script');</script>
<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-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#failureConfiguringAlert" class="member-name-link">failureConfiguringAlert</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</div>
</div>
<div class="col-first even-row-color"><code>com.revrobotics.CANSparkMax</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">SparkMAX Instance.</div>
</div>
<div class="col-first even-row-color"><code>com.revrobotics.SparkPIDController</code></div>
<div class="col-second even-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#noEncoderAlert" class="member-name-link">noEncoderAlert</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#noEncoderDefinedAlert" class="member-name-link">noEncoderDefinedAlert</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder defined.</div>
</div>
<div class="col-first odd-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-last odd-row-color">
<div class="block">Closed-loop PID controller.</div>
</div>
</div>
@@ -333,6 +348,27 @@ loadScripts(document, 'script');</script>
<div class="block">Factory default already occurred.</div>
</section>
</li>
<li>
<section class="detail" id="noEncoderAlert">
<h3>noEncoderAlert</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">noEncoderAlert</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder.</div>
</section>
</li>
<li>
<section class="detail" id="failureConfiguringAlert">
<h3>failureConfiguringAlert</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">failureConfiguringAlert</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</div>
</section>
</li>
<li>
<section class="detail" id="noEncoderDefinedAlert">
<h3>noEncoderDefinedAlert</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">noEncoderDefinedAlert</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder defined.</div>
</section>
</li>
</ul>
</section>
</li>

4
docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 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-16">
<meta name="dc.created" content="2024-01-17">
<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">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SparkMaxSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveMotor</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors, class: SwerveMotor">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>TalonFXSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors, class: TalonFXSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -325,13 +325,6 @@ loadScripts(document, 'script');</script>
</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>
@@ -367,6 +360,13 @@ loadScripts(document, 'script');</script>
<div class="block">TalonFX motor controller.</div>
</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>
</ul>
</section>
</li>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>TalonSRXSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors, class: TalonSRXSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.motors</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.motors">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.motors Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.motors">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>PIDFConfig</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser, class: PIDFConfig">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveControllerConfiguration</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveControllerConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveDriveConfiguration</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveDriveConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveModuleConfiguration</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModuleConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveModulePhysicalCharacteristics</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModulePhysicalCharacteristics">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveParser</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveParser">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>PIDFRange</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.deserializer, class: PIDFRange">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser.deserializer</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.deserializer">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser.deserializer Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.parser.deserializer">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/ControllerPropertiesJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>ControllerPropertiesJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: ControllerPropertiesJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

28
docs/swervelib/parser/json/DeviceJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>DeviceJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: DeviceJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
@@ -96,6 +96,16 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color">
<div class="block">The CAN bus name which the device resides on if using CAN.</div>
</div>
<div class="col-first odd-row-color"><code>private final <a href="../../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#canIdWarning" class="member-name-link">canIdWarning</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CAN ID is greater than 40.</div>
</div>
<div class="col-first even-row-color"><code>private final <a href="../../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#i2cLockupWarning" class="member-name-link">i2cLockupWarning</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an I2C lockup issue on the roboRIO.</div>
</div>
<div class="col-first odd-row-color"><code>int</code></div>
<div class="col-second odd-row-color"><code><a href="#id" class="member-name-link">id</a></code></div>
<div class="col-last odd-row-color">
@@ -166,6 +176,20 @@ loadScripts(document, 'script');</script>
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="canIdWarning">
<h3>canIdWarning</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="../../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">canIdWarning</span></div>
<div class="block">An <a href="../../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CAN ID is greater than 40.</div>
</section>
</li>
<li>
<section class="detail" id="i2cLockupWarning">
<h3>i2cLockupWarning</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="../../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">i2cLockupWarning</span></div>
<div class="block">An <a href="../../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an I2C lockup issue on the roboRIO.</div>
</section>
</li>
<li>
<section class="detail" id="type">
<h3>type</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">type</span></div>

4
docs/swervelib/parser/json/ModuleJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>ModuleJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: ModuleJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/MotorConfigDouble.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>MotorConfigDouble</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: MotorConfigDouble">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/MotorConfigInt.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>MotorConfigInt</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: MotorConfigInt">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/PIDFPropertiesJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>PIDFPropertiesJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: PIDFPropertiesJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/PhysicalPropertiesJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>PhysicalPropertiesJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: PhysicalPropertiesJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/SwerveDriveJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveDriveJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json, class: SwerveDriveJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/modules/BoolMotorJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>BoolMotorJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json.modules, class: BoolMotorJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/modules/LocationJson.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>LocationJson</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json.modules, class: LocationJson">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/modules/package-summary.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser.json.modules</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json.modules">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/modules/package-tree.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser.json.modules Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.parser.json.modules">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/package-summary.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser.json</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser.json">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/json/package-tree.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser.json Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.parser.json">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">

4
docs/swervelib/parser/package-summary.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.parser">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

4
docs/swervelib/parser/package-tree.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.parser Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.parser">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

4
docs/swervelib/simulation/SwerveIMUSimulation.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveIMUSimulation</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.simulation, class: SwerveIMUSimulation">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

4
docs/swervelib/simulation/SwerveModuleSimulation.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveModuleSimulation</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.simulation, class: SwerveModuleSimulation">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

4
docs/swervelib/simulation/package-summary.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.simulation</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.simulation">
<meta name="generator" content="javadoc/PackageWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

4
docs/swervelib/simulation/package-tree.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>swervelib.simulation Class Hierarchy</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="tree: package: swervelib.simulation">
<meta name="generator" content="javadoc/PackageTreeWriter">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">

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