mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
Update to 2024.4.8
This commit is contained in:
thenetworkgrinch
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="class index">
|
||||
<meta name="generator" content="javadoc/AllClassesIndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
@@ -96,181 +96,185 @@ loadScripts(document, 'script');</script>
|
||||
<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 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-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="swervelib/parser/Cache.html" title="type parameter in Cache">T</a>></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Cache for frequently requested data.</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="block">HELIUM <code>Canandcoder</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
||||
</div>
|
||||
<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="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="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
|
||||
</div>
|
||||
<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="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="block"><a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div>
|
||||
</div>
|
||||
<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="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="block">Device JSON parsed class.</div>
|
||||
</div>
|
||||
<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="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="block">Location JSON parsed class.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="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="block">Object with significant mass that needs to be taken into account.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></div>
|
||||
<div class="col-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/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="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></div>
|
||||
<div class="col-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/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="block">Used to store doubles for motor configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></div>
|
||||
<div class="col-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/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="block">Used to store ints for motor configuration.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></div>
|
||||
<div class="col-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/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="block">Communicates with the NavX as the IMU.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></div>
|
||||
<div class="col-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/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="block"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
|
||||
<div class="col-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/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="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></div>
|
||||
<div class="col-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/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="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 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="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="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></div>
|
||||
<div class="col-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/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="block">SwerveIMU interface for the Pigeon2</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></div>
|
||||
<div class="col-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/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="block">SwerveIMU interface for the Pigeon.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></div>
|
||||
<div class="col-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/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="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 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="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="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 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-first even-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></div>
|
||||
<div class="col-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/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></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">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/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">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></div>
|
||||
<div class="col-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/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="block">Controller class used to convert raw inputs into robot speeds.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></div>
|
||||
<div class="col-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/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="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 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="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="block">Swerve Drive class representing and controlling the swerve drive.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></div>
|
||||
<div class="col-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/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="block">Swerve drive configurations used during SwerveDrive construction.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></div>
|
||||
<div class="col-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/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="block"><a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></div>
|
||||
<div class="col-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/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="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 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="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="block">Verbosity of telemetry data sent back.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</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/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Class to perform tests on the swerve drive.</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>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="package index">
|
||||
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="summary of constants">
|
||||
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
@@ -53,6 +53,7 @@ loadScripts(document, 'script');</script>
|
||||
<h2 title="Contents">Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#swervelib.encoders">swervelib.encoders.*</a></li>
|
||||
<li><a href="#swervelib.imu">swervelib.imu.*</a></li>
|
||||
<li><a href="#swervelib.motors">swervelib.motors.*</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -61,6 +62,17 @@ loadScripts(document, 'script');</script>
|
||||
<h2 title="swervelib.encoders">swervelib.encoders.*</h2>
|
||||
<ul class="block-list">
|
||||
<li>
|
||||
<div class="caption"><span>swervelib.encoders.<a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Constant Field</div>
|
||||
<div class="table-header col-last">Value</div>
|
||||
<div class="col-first even-row-color"><code id="swervelib.encoders.CANCoderSwerve.STATUS_TIMEOUT_SECONDS">private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="swervelib/encoders/CANCoderSwerve.html#STATUS_TIMEOUT_SECONDS">STATUS_TIMEOUT_SECONDS</a></code></div>
|
||||
<div class="col-last even-row-color"><code>0.02</code></div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div class="caption"><span>swervelib.encoders.<a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
@@ -73,6 +85,22 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="constants-summary" id="swervelib.imu">
|
||||
<h2 title="swervelib.imu">swervelib.imu.*</h2>
|
||||
<ul class="block-list">
|
||||
<li>
|
||||
<div class="caption"><span>swervelib.imu.<a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Constant Field</div>
|
||||
<div class="table-header col-last">Value</div>
|
||||
<div class="col-first even-row-color"><code id="swervelib.imu.Pigeon2Swerve.STATUS_TIMEOUT_SECONDS">private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="swervelib/imu/Pigeon2Swerve.html#STATUS_TIMEOUT_SECONDS">STATUS_TIMEOUT_SECONDS</a></code></div>
|
||||
<div class="col-last even-row-color"><code>0.02</code></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="constants-summary" id="swervelib.motors">
|
||||
<h2 title="swervelib.motors">swervelib.motors.*</h2>
|
||||
<ul class="block-list">
|
||||
@@ -99,6 +127,9 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonFXSwerve.factoryDefaultOccurred">private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last odd-row-color"><code>false</code></div>
|
||||
<div class="col-first even-row-color"><code id="swervelib.motors.TalonFXSwerve.STATUS_TIMEOUT_SECONDS">private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#STATUS_TIMEOUT_SECONDS">STATUS_TIMEOUT_SECONDS</a></code></div>
|
||||
<div class="col-last even-row-color"><code>0.02</code></div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="help">
|
||||
<meta name="generator" content="javadoc/HelpWriter">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: A">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -97,6 +97,10 @@ loadScripts(document, 'script');</script>
|
||||
<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/SwerveModule.html#absolutePositionCache" class="member-name-link">absolutePositionCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder position cache.</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>
|
||||
<div class="block">Activation state of alert.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: K">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: L">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -95,6 +95,32 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#logAngularMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logAngularMotorActivity(SwerveModule, SysIdRoutineLog, Supplier<Double>)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#logAngularMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorDutyCycle(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#logAngularMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorVoltage(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#logDriveMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logDriveMotorActivity(SwerveModule, SysIdRoutineLog, Supplier<Double>)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logs power, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#logDriveMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorDutyCycle(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logs output, position and velocuty info form the drive motor to the SysIdRoutineLog <br/> Although SysIdRoutine
|
||||
expects to be logging Voltage, this function logs in Duty-Cycle (percent output) because it results in correctly
|
||||
adjusted values in the analysis for use in this library.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#logDriveMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorVoltage(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logs voltage, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#LOW" class="member-name-link">LOW</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">Low telemetry data, only post the robot position on the field.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: M">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -53,10 +53,30 @@ loadScripts(document, 'script');</script>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:M">M</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_anglePosition" class="member-name-link">m_anglePosition</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Tracks the rotations of an angular motor</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#m_angleVoltageSetter" class="member-name-link">m_angleVoltageSetter</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Motion magic angle voltage setter.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_angVelocity" class="member-name-link">m_angVelocity</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Tracks the velocity of an angular motor</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_appliedVoltage" class="member-name-link">m_appliedVoltage</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Tracks the voltage being applied to a motor</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_distance" class="member-name-link">m_distance</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Tracks the distance travelled of a position motor</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_velocity" class="member-name-link">m_velocity</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Tracks the velocity of a positional motor</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#m_velocityVoltageSetter" class="member-name-link">m_velocityVoltageSetter</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Velocity voltage setter for controlling drive motor.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: N">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: O">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: P">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -159,6 +159,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Position in meters from robot center in 3d space.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#position" class="member-name-link">position</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Supplier for the position of the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Position" class="member-name-link">Position</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Slot 1, used for position PID's.</div>
|
||||
@@ -175,7 +179,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Post the trajectory to the field</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#powerAngleMotors(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotors(SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#powerAngleMotorsDutyCycle(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotorsDutyCycle(SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Power the angle motors for the swerve drive to a set percentage.</div>
|
||||
</dd>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: Q">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: R">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: S">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -159,6 +159,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#setAngleSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive)" class="member-name-link">setAngleSysIdRoutine(SysIdRoutine.Config, SubsystemBase, SwerveDrive)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Sets up the SysId runner and logger for the angle motors</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set chassis speeds with closed-loop velocity control.</div>
|
||||
@@ -209,6 +213,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#setDriveSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive,double)" class="member-name-link">setDriveSysIdRoutine(SysIdRoutine.Config, SubsystemBase, SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Sets up the SysId runner and logger for the drive motors</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setGyro(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyro(Rotation3d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object.</div>
|
||||
@@ -618,10 +626,26 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Current simulated swerve module state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#stopOdometryThread()" class="member-name-link">stopOdometryThread()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Stop the odometry thread in favor of manually updating odometry.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#supplier" class="member-name-link">supplier</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Supplier for cached value.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: T">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -99,6 +99,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Main timer to simulate the passage of time.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#timestamp" class="member-name-link">timestamp</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Timestamp in microseconds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#tunerXRecommendation" class="member-name-link">tunerXRecommendation</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Alert to recommend Tuner X if the configuration is compatible.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: B">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: U">
|
||||
<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> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:U">U</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/Cache.html#update()" class="member-name-link">update()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update the cache value and timestamp.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#updateCacheValidityPeriods(long,long,long)" class="member-name-link">updateCacheValidityPeriods(long, long, long)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update the cache validity period for the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#updateData()" class="member-name-link">updateData()</a> - Static method in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">Upload data to smartdashboard</div>
|
||||
@@ -70,10 +78,18 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Update the position and state of the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#updateSupplier(java.util.function.Supplier)" class="member-name-link">updateSupplier(Supplier<T>)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update the supplier to a new source.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#updateTelemetry()" class="member-name-link">updateTelemetry()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update data sent to <code>SmartDashboard</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#updateValidityPeriod(long)" class="member-name-link">updateValidityPeriod(long)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update the validity period for the cached value, also updates the value.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#useCosineCompensator" class="member-name-link">useCosineCompensator</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">Should do cosine compensation when not pointing correct direction;.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: V">
|
||||
<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> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:V">V</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/Cache.html#validityPeriod" class="member-name-link">validityPeriod</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Validity period in microseconds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#value" class="member-name-link">value</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Cached value.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
||||
@@ -89,6 +97,10 @@ 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/motors/SparkMaxSwerve.html#velocity" class="member-name-link">velocity</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Supplier for the velocity of the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Velocity" class="member-name-link">Velocity</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Slot 2, used for velocity PID's.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: W">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: X">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: Y">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: Z">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: C">
|
||||
<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> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:C">C</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/Cache.html" class="type-name-link" title="class in swervelib.parser">Cache</a><<a href="../swervelib/parser/Cache.html" title="type parameter in Cache">T</a>> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Cache for frequently requested data.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#%3Cinit%3E(java.util.function.Supplier,long)" class="member-name-link">Cache(Supplier<T>, long)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Cache for arbitrary values.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">calcMaxAccel(Rotation2d, List<Matter>, double, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot.</div>
|
||||
@@ -427,6 +435,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Convert the setpoint into native sensor units.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#createConfigCustomTimeout(double)" class="member-name-link">createConfigCustomTimeout(double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a SysIdRoutine.Config with a custom final timeout</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#createControllerConfiguration(swervelib.parser.SwerveDriveConfiguration,double)" class="member-name-link">createControllerConfiguration(SwerveDriveConfiguration, double)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the <a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> based on parsed and given data.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: D">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -143,6 +143,14 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#drivePositionCache" class="member-name-link">drivePositionCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor position cache.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#driveVelocityCache" class="member-name-link">driveVelocityCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor velocity cache.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#dt" class="member-name-link">dt</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Time delta since last update</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: E">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: F">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: G">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -53,6 +53,10 @@ loadScripts(document, 'script');</script>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:G">G</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveDriveTest.html#generateSysIdCommand(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine,double,double,double)" class="member-name-link">generateSysIdCommand(SysIdRoutine, double, double, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a command that can be mapped to a button or other trigger.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
||||
@@ -271,6 +275,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Get the swerve module by the json name.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getModuleMap()" class="member-name-link">getModuleMap()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>'s as a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link"><code>HashMap</code></a> where the key is the swerve module configuration name.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getModulePositions()" class="member-name-link">getModulePositions()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current module positions (azimuth and wheel position (meters)).</div>
|
||||
@@ -351,6 +359,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Get the position of the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getRawAbsolutePosition()" class="member-name-link">getRawAbsolutePosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
@@ -481,6 +493,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Helper function to get the <code>Translation2d</code> of the chassis speeds given the <code>ChassisSpeeds</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#getValue()" class="member-name-link">getValue()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the most up to date cached value.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the velocity in degrees/sec.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: H">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index: I">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -97,6 +97,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#imuReadingCache" class="member-name-link">imuReadingCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">IMU reading cache for robot readings.</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>
|
||||
@@ -187,6 +191,10 @@ loadScripts(document, 'script');</script>
|
||||
<dd>
|
||||
<div class="block">State of simulation of the Robot, used to optimize retrieval.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/Cache.html#isStale()" class="member-name-link">isStale()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
||||
<dd>
|
||||
<div class="block">Return whether the cache is stale.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#iz" class="member-name-link">iz</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Integral zone of the PID.</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="package index">
|
||||
<meta name="generator" content="javadoc/PackageIndexWriter">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="index redirect">
|
||||
<meta name="generator" content="javadoc/IndexRedirectWriter">
|
||||
<link rel="canonical" href="index.html">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="class tree">
|
||||
<meta name="generator" content="javadoc/TreeWriter">
|
||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
||||
@@ -72,6 +72,7 @@ loadScripts(document, 'script');</script>
|
||||
<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.<a href="swervelib/parser/Cache.html" class="type-name-link" title="class in swervelib.parser">Cache</a><T></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ControllerPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">ControllerPropertiesJson</a></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/DeviceJson.html" class="type-name-link" title="class in swervelib.parser.json">DeviceJson</a></li>
|
||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a></li>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -127,64 +127,69 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>final edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#kinematics" class="member-name-link">kinematics</a></code></div>
|
||||
<div class="col-first odd-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><edu.wpi.first.math.geometry.Rotation3d></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#imuReadingCache" class="member-name-link">imuReadingCache</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">IMU reading cache for robot readings.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>final edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#kinematics" class="member-name-link">kinematics</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve Kinematics object.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The last heading set in radians.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Maximum speed of the robot in meters per second.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>private int</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks" class="external-link">Lock</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#odometryLock" class="member-name-link">odometryLock</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/locks/Lock.html" title="class or interface in java.util.concurrent.locks" class="external-link">Lock</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#odometryLock" class="member-name-link">odometryLock</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Odometry lock to ensure thread safety.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.Notifier</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#odometryThread" class="member-name-link">odometryThread</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.wpilibj.Notifier</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#odometryThread" class="member-name-link">odometryThread</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">WPILib <code>Notifier</code> to keep odometry up to date.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#simIMU" class="member-name-link">simIMU</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>private <a href="simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#simIMU" class="member-name-link">simIMU</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Simulation of the swerve drive.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#swerveController" class="member-name-link">swerveController</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#swerveController" class="member-name-link">swerveController</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve controller for controlling heading of the robot.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#swerveDriveConfiguration" class="member-name-link">swerveDriveConfiguration</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>final <a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#swerveDriveConfiguration" class="member-name-link">swerveDriveConfiguration</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve drive configuration.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>final edu.wpi.first.math.estimator.SwerveDrivePoseEstimator</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#swerveDrivePoseEstimator" class="member-name-link">swerveDrivePoseEstimator</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>final edu.wpi.first.math.estimator.SwerveDrivePoseEstimator</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#swerveDrivePoseEstimator" class="member-name-link">swerveDrivePoseEstimator</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve odometry.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final <a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#swerveModules" class="member-name-link">swerveModules</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>private final <a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#swerveModules" class="member-name-link">swerveModules</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve modules.</div>
|
||||
</div>
|
||||
<div class="col-first 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="#tunerXRecommendation" class="member-name-link">tunerXRecommendation</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<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="#tunerXRecommendation" class="member-name-link">tunerXRecommendation</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Alert to recommend Tuner X if the configuration is compatible.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -316,190 +321,202 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Get the maximum velocity from <a href="#attainableMaxTranslationalSpeedMetersPerSecond"><code>attainableMaxTranslationalSpeedMetersPerSecond</code></a> or
|
||||
<a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> whichever is higher.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModulePosition[]</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModulePositions()" class="member-name-link">getModulePositions</a>()</code></div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModuleMap()" class="member-name-link">getModuleMap</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>'s as a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link"><code>HashMap</code></a> where the key is the swerve module configuration name.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModulePosition[]</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModulePositions()" class="member-name-link">getModulePositions</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current module positions (azimuth and wheel position (meters)).</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModules()" class="member-name-link">getModules</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getModules()" class="member-name-link">getModules</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>s associated with the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOdometryHeading()" class="member-name-link">getOdometryHeading</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOdometryHeading()" class="member-name-link">getOdometryHeading</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Fetch the latest odometry heading, should be trusted over <a href="#getYaw()"><code>getYaw()</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPitch()" class="member-name-link">getPitch</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPitch()" class="member-name-link">getPitch</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current pitch angle of the robot, as reported by the imu.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Pose2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPose()" class="member-name-link">getPose</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Pose2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPose()" class="member-name-link">getPose</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current pose (position and rotation) of the robot, as reported by odometry.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRobotVelocity()" class="member-name-link">getRobotVelocity</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRobotVelocity()" class="member-name-link">getRobotVelocity</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current robot-relative velocity (x, y and omega) of the robot</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoll()" class="member-name-link">getRoll</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRoll()" class="member-name-link">getRoll</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current roll angle of the robot, as reported by the imu.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModuleState[]</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStates()" class="member-name-link">getStates</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModuleState[]</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStates()" class="member-name-link">getStates</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current module states (azimuth and velocity)</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveController()" class="member-name-link">getSwerveController</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveController()" class="member-name-link">getSwerveController</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Helper function to get the <a href="#swerveController"><code>swerveController</code></a> for the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> which can be used to
|
||||
generate <code>ChassisSpeeds</code> for the robot to orient it correctly given axis or angles, and apply
|
||||
<code>SlewRateLimiter</code> to given inputs.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Pose2d[]</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveModulePoses(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">getSwerveModulePoses</a><wbr>(edu.wpi.first.math.geometry.Pose2d robotPose)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Pose2d[]</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveModulePoses(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">getSwerveModulePoses</a><wbr>(edu.wpi.first.math.geometry.Pose2d robotPose)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the swerve module poses and on the field relative to the robot.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getYaw()" class="member-name-link">getYaw</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getYaw()" class="member-name-link">getYaw</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lockPose()" class="member-name-link">lockPose</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lockPose()" class="member-name-link">lockPose</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#postTrajectory(edu.wpi.first.math.trajectory.Trajectory)" class="member-name-link">postTrajectory</a><wbr>(edu.wpi.first.math.trajectory.Trajectory trajectory)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#postTrajectory(edu.wpi.first.math.trajectory.Trajectory)" class="member-name-link">postTrajectory</a><wbr>(edu.wpi.first.math.trajectory.Trajectory trajectory)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Post the trajectory to the field</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Pushes the Absolute Encoder offsets to the Encoder or Motor Controller, depending on type.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#replaceSwerveModuleFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">replaceSwerveModuleFeedforward</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward feedforward)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#replaceSwerveModuleFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">replaceSwerveModuleFeedforward</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward feedforward)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Setup the swerve module feedforward.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetDriveEncoders()" class="member-name-link">resetDriveEncoders</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetDriveEncoders()" class="member-name-link">resetDriveEncoders</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a reboot, like in
|
||||
autonomous.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetOdometry(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetOdometry</a><wbr>(edu.wpi.first.math.geometry.Pose2d pose)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetOdometry(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetOdometry</a><wbr>(edu.wpi.first.math.geometry.Pose2d pose)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Resets odometry to the given pose.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restoreInternalOffset()" class="member-name-link">restoreInternalOffset</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restoreInternalOffset()" class="member-name-link">restoreInternalOffset</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Restores Internal YAGSL Encoder offsets and sets the Encoder stored offset back to 0</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds</a><wbr>(edu.wpi.first.math.kinematics.ChassisSpeeds chassisSpeeds)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds</a><wbr>(edu.wpi.first.math.kinematics.ChassisSpeeds chassisSpeeds)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set chassis speeds with closed-loop velocity control.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the conversion factor for the drive motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGyro(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyro</a><wbr>(edu.wpi.first.math.geometry.Rotation3d gyro)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGyro(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyro</a><wbr>(edu.wpi.first.math.geometry.Rotation3d gyro)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyroOffset</a><wbr>(edu.wpi.first.math.geometry.Rotation3d offset)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyroOffset</a><wbr>(edu.wpi.first.math.geometry.Rotation3d offset)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the gyro scope offset to a desired known rotation.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeadingCorrection(boolean)" class="member-name-link">setHeadingCorrection</a><wbr>(boolean state)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the heading correction capabilities of YAGSL.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeadingCorrection(boolean,double)" class="member-name-link">setHeadingCorrection</a><wbr>(boolean state,
|
||||
double deadband)</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeadingCorrection(boolean)" class="member-name-link">setHeadingCorrection</a><wbr>(boolean state)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the heading correction capabilities of YAGSL.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed</a><wbr>(double maximumSpeed)</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeadingCorrection(boolean,double)" class="member-name-link">setHeadingCorrection</a><wbr>(boolean state,
|
||||
double deadband)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the heading correction capabilities of YAGSL.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed</a><wbr>(double maximumSpeed)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> which is used for the
|
||||
<a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double,boolean,double)" class="member-name-link">setMaximumSpeed</a><wbr>(double maximumSpeed,
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double,boolean,double)" class="member-name-link">setMaximumSpeed</a><wbr>(double maximumSpeed,
|
||||
boolean updateModuleFeedforward,
|
||||
double optimalVoltage)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="#maxSpeedMPS"><code>maxSpeedMPS</code></a> which is used for the
|
||||
<a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeeds(double,double,double)" class="member-name-link">setMaximumSpeeds</a><wbr>(double attainableMaxModuleSpeedMetersPerSecond,
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeeds(double,double,double)" class="member-name-link">setMaximumSpeeds</a><wbr>(double attainableMaxModuleSpeedMetersPerSecond,
|
||||
double attainableMaxTranslationalSpeedMetersPerSecond,
|
||||
double attainableMaxRotationalVelocityRadiansPerSecond)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the maximum speeds for desaturation.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setModuleStates</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState[] desiredStates,
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setModuleStates</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState[] desiredStates,
|
||||
boolean isOpenLoop)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the module states (azimuth and velocity) directly.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorIdleMode(boolean)" class="member-name-link">setMotorIdleMode</a><wbr>(boolean brake)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorIdleMode(boolean)" class="member-name-link">setMotorIdleMode</a><wbr>(boolean brake)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Sets the drive motors to brake/coast mode.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOdometryPeriod(double)" class="member-name-link">setOdometryPeriod</a><wbr>(double period)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOdometryPeriod(double)" class="member-name-link">setOdometryPeriod</a><wbr>(double period)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the odometry update period in seconds.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setRawModuleStates</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState[] desiredStates,
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setRawModuleStates</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState[] desiredStates,
|
||||
boolean isOpenLoop)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the module states (azimuth and velocity) directly.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopOdometryThread()" class="member-name-link">stopOdometryThread</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopOdometryThread()" class="member-name-link">stopOdometryThread</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Stop the odometry thread in favor of manually updating odometry.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateCacheValidityPeriods(long,long,long)" class="member-name-link">updateCacheValidityPeriods</a><wbr>(long imu,
|
||||
long driveMotor,
|
||||
long absoluteEncoder)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update the cache validity period for the robot.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateOdometry()" class="member-name-link">updateOdometry</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
@@ -549,6 +566,13 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="imuReadingCache">
|
||||
<h3>imuReadingCache</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><edu.wpi.first.math.geometry.Rotation3d></span> <span class="element-name">imuReadingCache</span></div>
|
||||
<div class="block">IMU reading cache for robot readings.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="swerveModules">
|
||||
<h3>swerveModules</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</span> <span class="element-name">swerveModules</span></div>
|
||||
@@ -699,6 +723,21 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="updateCacheValidityPeriods(long,long,long)">
|
||||
<h3>updateCacheValidityPeriods</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateCacheValidityPeriods</span><wbr><span class="parameters">(long imu,
|
||||
long driveMotor,
|
||||
long absoluteEncoder)</span></div>
|
||||
<div class="block">Update the cache validity period for the robot.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>imu</code> - IMU reading cache validity period in milliseconds.</dd>
|
||||
<dd><code>driveMotor</code> - Drive motor reading cache in milliseconds.</dd>
|
||||
<dd><code>absoluteEncoder</code> - Absolute encoder reading cache in milliseconds.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="checkIfTunerXCompatible()">
|
||||
<h3>checkIfTunerXCompatible</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">checkIfTunerXCompatible</span>()</div>
|
||||
@@ -1313,6 +1352,17 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getModuleMap()">
|
||||
<h3>getModuleMap</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>></span> <span class="element-name">getModuleMap</span>()</div>
|
||||
<div class="block">Get the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>'s as a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link"><code>HashMap</code></a> where the key is the swerve module configuration name.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link"><code>HashMap</code></a>(Module Name, SwerveModule)</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="resetDriveEncoders()">
|
||||
<h3>resetDriveEncoders</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">resetDriveEncoders</span>()</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 CST 2024 -->
|
||||
<title>SwerveDriveTest</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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="declaration: package: swervelib, class: SwerveDriveTest">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
@@ -45,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -82,6 +82,43 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Angle></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_anglePosition" class="member-name-link">m_anglePosition</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Tracks the rotations of an angular motor</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Angle>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_angVelocity" class="member-name-link">m_angVelocity</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Tracks the velocity of an angular motor</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Voltage></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_appliedVoltage" class="member-name-link">m_appliedVoltage</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Tracks the voltage being applied to a motor</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Distance></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_distance" class="member-name-link">m_distance</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Tracks the distance travelled of a position motor</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Distance>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_velocity" class="member-name-link">m_velocity</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Tracks the velocity of a positional motor</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -117,23 +154,76 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Set the modules to center to 0.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findCouplingRatio(swervelib.SwerveDrive,double,boolean)" class="member-name-link">findCouplingRatio</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double volts,
|
||||
boolean automatic)</code></div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createConfigCustomTimeout(double)" class="member-name-link">createConfigCustomTimeout</a><wbr>(double timeout)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Find the coupling ratio for all modules.</div>
|
||||
<div class="block">Creates a SysIdRoutine.Config with a custom final timeout</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findDriveMotorKV(swervelib.SwerveDrive,double,double,double)" class="member-name-link">findDriveMotorKV</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findCouplingRatio(swervelib.SwerveDrive,double,boolean)" class="member-name-link">findCouplingRatio</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double volts,
|
||||
boolean automatic)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Find the coupling ratio for all modules.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findDriveMotorKV(swervelib.SwerveDrive,double,double,double)" class="member-name-link">findDriveMotorKV</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double minMovement,
|
||||
double testDelaySeconds,
|
||||
double maxVolts)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Find the minimum amount of power required to move the swerve drive motors.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.Command</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#generateSysIdCommand(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine,double,double,double)" class="member-name-link">generateSysIdCommand</a><wbr>(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine sysIdRoutine,
|
||||
double delay,
|
||||
double quasiTimeout,
|
||||
double dynamicTimeout)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Creates a command that can be mapped to a button or other trigger.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerAngleMotors(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotors</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logAngularMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logAngularMotorActivity</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logAngularMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorDutyCycle</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logAngularMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorVoltage</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logDriveMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logDriveMotorActivity</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logs power, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logDriveMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorDutyCycle</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logs output, position and velocuty info form the drive motor to the SysIdRoutineLog <br/> Although SysIdRoutine
|
||||
expects to be logging Voltage, this function logs in Duty-Cycle (percent output) because it results in correctly
|
||||
adjusted values in the analysis for use in this library.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logDriveMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorVoltage</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logs voltage, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerAngleMotorsDutyCycle(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotorsDutyCycle</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double percentage)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Power the angle motors for the swerve drive to a set percentage.</div>
|
||||
@@ -156,6 +246,21 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Power the drive motors for the swerve drive to a set voltage.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setAngleSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive)" class="member-name-link">setAngleSysIdRoutine</a><wbr>(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Sets up the SysId runner and logger for the angle motors</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setDriveSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive,double)" class="member-name-link">setDriveSysIdRoutine</a><wbr>(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double maxVolts)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Sets up the SysId runner and logger for the drive motors</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -168,6 +273,49 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="m_appliedVoltage">
|
||||
<h3>m_appliedVoltage</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Voltage></span> <span class="element-name">m_appliedVoltage</span></div>
|
||||
<div class="block">Tracks the voltage being applied to a motor</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_distance">
|
||||
<h3>m_distance</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Distance></span> <span class="element-name">m_distance</span></div>
|
||||
<div class="block">Tracks the distance travelled of a position motor</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_velocity">
|
||||
<h3>m_velocity</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Distance>></span> <span class="element-name">m_velocity</span></div>
|
||||
<div class="block">Tracks the velocity of a positional motor</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_anglePosition">
|
||||
<h3>m_anglePosition</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Angle></span> <span class="element-name">m_anglePosition</span></div>
|
||||
<div class="block">Tracks the rotations of an angular motor</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_angVelocity">
|
||||
<h3>m_angVelocity</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Angle>></span> <span class="element-name">m_angVelocity</span></div>
|
||||
<div class="block">Tracks the velocity of an angular motor</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -214,9 +362,9 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="powerAngleMotors(swervelib.SwerveDrive,double)">
|
||||
<h3>powerAngleMotors</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">powerAngleMotors</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
<section class="detail" id="powerAngleMotorsDutyCycle(swervelib.SwerveDrive,double)">
|
||||
<h3>powerAngleMotorsDutyCycle</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">powerAngleMotorsDutyCycle</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double percentage)</span></div>
|
||||
<div class="block">Power the angle motors for the swerve drive to a set percentage.</div>
|
||||
<dl class="notes">
|
||||
@@ -299,6 +447,161 @@ loadScripts(document, 'script');</script>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="createConfigCustomTimeout(double)">
|
||||
<h3>createConfigCustomTimeout</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config</span> <span class="element-name">createConfigCustomTimeout</span><wbr><span class="parameters">(double timeout)</span></div>
|
||||
<div class="block">Creates a SysIdRoutine.Config with a custom final timeout</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>timeout</code> - - the most a SysIdRoutine should run</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A custom SysIdRoutine.Config</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="logDriveMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
||||
<h3>logDriveMotorDutyCycle</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logDriveMotorDutyCycle</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
||||
<div class="block">Logs output, position and velocuty info form the drive motor to the SysIdRoutineLog <br/> Although SysIdRoutine
|
||||
expects to be logging Voltage, this function logs in Duty-Cycle (percent output) because it results in correctly
|
||||
adjusted values in the analysis for use in this library.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
||||
<dd><code>log</code> - - the logger</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="logDriveMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
||||
<h3>logDriveMotorVoltage</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logDriveMotorVoltage</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
||||
<div class="block">Logs voltage, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
||||
<dd><code>log</code> - - the logger</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="logDriveMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)">
|
||||
<h3>logDriveMotorActivity</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logDriveMotorActivity</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</span></div>
|
||||
<div class="block">Logs power, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
||||
<dd><code>log</code> - - the logger</dd>
|
||||
<dd><code>powerSupplied</code> - - a functional supplier of the power to be logged</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="setDriveSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive,double)">
|
||||
<h3>setDriveSysIdRoutine</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</span> <span class="element-name">setDriveSysIdRoutine</span><wbr><span class="parameters">(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
||||
double maxVolts)</span></div>
|
||||
<div class="block">Sets up the SysId runner and logger for the drive motors</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>config</code> - - The SysIdRoutine.Config to use</dd>
|
||||
<dd><code>swerveSubsystem</code> - - the subsystem to add to requirements</dd>
|
||||
<dd><code>swerveDrive</code> - - the SwerveDrive from which to access motor info</dd>
|
||||
<dd><code>maxVolts</code> - - The maximum voltage that should be applied to the drive motors.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A SysIdRoutine runner</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="logAngularMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
||||
<h3>logAngularMotorDutyCycle</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logAngularMotorDutyCycle</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog. <br/> Although SysIdRoutine expects to be logging Voltage,
|
||||
this function logs in Duty-Cycle (percent output) because it results in correctly adjusted values in the analysis
|
||||
for use in this library.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
||||
<dd><code>log</code> - - the logger</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="logAngularMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
||||
<h3>logAngularMotorVoltage</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logAngularMotorVoltage</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
||||
<dd><code>log</code> - - the logger</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="logAngularMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)">
|
||||
<h3>logAngularMotorActivity</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logAngularMotorActivity</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</span></div>
|
||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
||||
<dd><code>log</code> - - the logger</dd>
|
||||
<dd><code>powerSupplied</code> - - a functional supplier of the power to be logged</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="setAngleSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive)">
|
||||
<h3>setAngleSysIdRoutine</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</span> <span class="element-name">setAngleSysIdRoutine</span><wbr><span class="parameters">(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive)</span></div>
|
||||
<div class="block">Sets up the SysId runner and logger for the angle motors</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>config</code> - - The SysIdRoutine.Config to use</dd>
|
||||
<dd><code>swerveSubsystem</code> - - the subsystem to add to requirements</dd>
|
||||
<dd><code>swerveDrive</code> - - the SwerveDrive from which to access motor info</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A SysIdRoutineRunner</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="generateSysIdCommand(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine,double,double,double)">
|
||||
<h3>generateSysIdCommand</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.Command</span> <span class="element-name">generateSysIdCommand</span><wbr><span class="parameters">(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine sysIdRoutine,
|
||||
double delay,
|
||||
double quasiTimeout,
|
||||
double dynamicTimeout)</span></div>
|
||||
<div class="block">Creates a command that can be mapped to a button or other trigger. Delays can be set to customize the length of
|
||||
each part of the SysId Routine</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>sysIdRoutine</code> - - The Sys Id routine runner</dd>
|
||||
<dd><code>delay</code> - - seconds between each portion to allow motors to spin down, etc...</dd>
|
||||
<dd><code>quasiTimeout</code> - - seconds to run the Quasistatic routines, so robot doesn't get too far</dd>
|
||||
<dd><code>dynamicTimeout</code> - - seconds to run the Dynamic routines, 2-3 secs should be enough</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>A command that can be mapped to a button or other trigger</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -96,64 +96,79 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Absolute encoder for swerve drive.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
|
||||
<div class="col-first odd-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#absolutePositionCache" class="member-name-link">absolutePositionCache</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Angle offset from the absolute encoder.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve module configuration options.</div>
|
||||
<div class="block">Absolute encoder position cache.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>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-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</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 class="block">Angle offset from the absolute encoder.</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-first even-row-color"><code>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Feedforward for drive motor during closed loop control.</div>
|
||||
<div class="block">Swerve module configuration options.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private 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-first odd-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Last swerve module state applied.</div>
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</div>
|
||||
<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-first even-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#drivePositionCache" class="member-name-link">drivePositionCache</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 class="block">Drive motor position cache.</div>
|
||||
</div>
|
||||
<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-first odd-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#driveVelocityCache" class="member-name-link">driveVelocityCache</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Module number for kinematics, usually 0 to 3.</div>
|
||||
<div class="block">Drive motor velocity cache.</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-second even-row-color"><code><a href="#encoderOffsetWarning" class="member-name-link">encoderOffsetWarning</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 pushing the Absolute Encoder offset to the encoder fails.</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-last odd-row-color">
|
||||
<div class="block">Feedforward for drive motor during closed loop control.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private 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="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="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="block">Module number for kinematics, usually 0 to 3.</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="#noEncoderWarning" class="member-name-link">noEncoderWarning</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 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">
|
||||
<div class="col-first even-row-color"><code>private <a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#simModule" class="member-name-link">simModule</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Simulated swerve module.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Encoder synchronization queued.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -228,70 +243,75 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Get the position of the swerve module.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelativePosition()" class="member-name-link">getRelativePosition</a>()</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRawAbsolutePosition()" class="member-name-link">getRawAbsolutePosition</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the absolute position.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelativePosition()" class="member-name-link">getRelativePosition</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the relative angle in degrees.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the Swerve Module state.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Push absolute encoder offset in the memory of the encoder or controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueSynchronizeEncoders()" class="member-name-link">queueSynchronizeEncoders</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueSynchronizeEncoders()" class="member-name-link">queueSynchronizeEncoders</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Queue synchronization of the integrated angle encoder with the absolute encoder.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restoreInternalOffset()" class="member-name-link">restoreInternalOffset</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restoreInternalOffset()" class="member-name-link">restoreInternalOffset</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Restore internal offset in YAGSL and either sets absolute encoder offset to 0 or restores old value.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngle(double)" class="member-name-link">setAngle</a><wbr>(double angle)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngle(double)" class="member-name-link">setAngle</a><wbr>(double angle)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the angle for the module.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorVoltageCompensation(double)" class="member-name-link">setAngleMotorVoltageCompensation</a><wbr>(double optimalVoltage)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorVoltageCompensation(double)" class="member-name-link">setAngleMotorVoltageCompensation</a><wbr>(double optimalVoltage)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDesiredState(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)" class="member-name-link">setDesiredState</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState desiredState,
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDesiredState(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)" class="member-name-link">setDesiredState</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState desiredState,
|
||||
boolean isOpenLoop,
|
||||
boolean force)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the desired state of the swerve module.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the conversion factor for the drive motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorVoltageCompensation(double)" class="member-name-link">setDriveMotorVoltageCompensation</a><wbr>(double optimalVoltage)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorVoltageCompensation(double)" class="member-name-link">setDriveMotorVoltageCompensation</a><wbr>(double optimalVoltage)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean brake)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean brake)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the brake mode.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateTelemetry()" class="member-name-link">updateTelemetry</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateTelemetry()" class="member-name-link">updateTelemetry</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update data sent to <code>SmartDashboard</code>.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -319,6 +339,27 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="absolutePositionCache">
|
||||
<h3>absolutePositionCache</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">absolutePositionCache</span></div>
|
||||
<div class="block">Absolute encoder position cache.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="drivePositionCache">
|
||||
<h3>drivePositionCache</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">drivePositionCache</span></div>
|
||||
<div class="block">Drive motor position cache.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="driveVelocityCache">
|
||||
<h3>driveVelocityCache</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">driveVelocityCache</span></div>
|
||||
<div class="block">Drive motor velocity cache.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="angleMotor">
|
||||
<h3>angleMotor</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">angleMotor</span></div>
|
||||
@@ -538,6 +579,17 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getRawAbsolutePosition()">
|
||||
<h3>getRawAbsolutePosition</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRawAbsolutePosition</span>()</div>
|
||||
<div class="block">Get the absolute position. Falls back to relative position on reading failure.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>Absolute encoder angle in degrees in the range [0, 360).</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getRelativePosition()">
|
||||
<h3>getRelativePosition</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRelativePosition</span>()</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -118,6 +118,11 @@ loadScripts(document, 'script');</script>
|
||||
<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 class="col-first odd-row-color"><code>private final double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
||||
@@ -208,6 +213,21 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="STATUS_TIMEOUT_SECONDS">
|
||||
<h3>STATUS_TIMEOUT_SECONDS</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">STATUS_TIMEOUT_SECONDS</span></div>
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.encoders.CANCoderSwerve.STATUS_TIMEOUT_SECONDS">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="encoder">
|
||||
<h3>encoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ctre.phoenix6.hardware.CANcoder</span> <span class="element-name">encoder</span></div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -108,6 +108,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Offset for the Pigeon 2.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
@@ -200,6 +205,21 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="STATUS_TIMEOUT_SECONDS">
|
||||
<h3>STATUS_TIMEOUT_SECONDS</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">STATUS_TIMEOUT_SECONDS</span></div>
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.imu.Pigeon2Swerve.STATUS_TIMEOUT_SECONDS">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="return-type">com.ctre.phoenix6.hardware.Pigeon2</span> <span class="element-name">imu</span></div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -135,6 +135,16 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#position" class="member-name-link">position</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Supplier for the position of the motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#velocity" class="member-name-link">velocity</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Supplier for the velocity of the motor controller.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3>
|
||||
@@ -361,6 +371,20 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="velocity">
|
||||
<h3>velocity</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">velocity</span></div>
|
||||
<div class="block">Supplier for the velocity of the motor controller.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="position">
|
||||
<h3>position</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">position</span></div>
|
||||
<div class="block">Supplier for the position of the motor controller.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -128,6 +128,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">TalonFX motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3>
|
||||
@@ -374,6 +379,21 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="STATUS_TIMEOUT_SECONDS">
|
||||
<h3>STATUS_TIMEOUT_SECONDS</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">STATUS_TIMEOUT_SECONDS</span></div>
|
||||
<div class="block">Wait time for status frames to show up.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.motors.TalonFXSwerve.STATUS_TIMEOUT_SECONDS">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="motor">
|
||||
<h3>motor</h3>
|
||||
<div class="member-signature"><span class="return-type">com.ctre.phoenix6.hardware.TalonFX</span> <span class="element-name">motor</span></div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="declaration: package: swervelib">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<meta name="description" content="tree: package: swervelib">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
||||
|
||||
312
docs/swervelib/parser/Cache.html
Normal file
312
docs/swervelib/parser/Cache.html
Normal file
@@ -0,0 +1,312 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 CST 2024 -->
|
||||
<title>Cache</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-02-02">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: Cache">
|
||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
||||
<script type="text/javascript" src="../../script.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../index.html">Overview</a></li>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li class="nav-bar-cell1-rev">Class</li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.parser</a></div>
|
||||
<h1 title="Class Cache" class="title">Class Cache<T></h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
||||
<div class="inheritance">swervelib.parser.Cache<T></div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Cache<T></span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
||||
<div class="block">Cache for frequently requested data.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Field</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Cache.html" title="type parameter in Cache">T</a>></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#supplier" class="member-name-link">supplier</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Supplier for cached value.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private long</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#timestamp" class="member-name-link">timestamp</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Timestamp in microseconds.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private long</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#validityPeriod" class="member-name-link">validityPeriod</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Validity period in microseconds.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="Cache.html" title="type parameter in Cache">T</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#value" class="member-name-link">value</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Cached value.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.function.Supplier,long)" class="member-name-link">Cache</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Cache.html" title="type parameter in Cache">T</a>> val,
|
||||
long validityPeriod)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Cache for arbitrary values.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Cache.html" title="type parameter in Cache">T</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getValue()" class="member-name-link">getValue</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Get the most up to date cached value.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStale()" class="member-name-link">isStale</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Return whether the cache is stale.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Cache.html" title="class in swervelib.parser">Cache</a><<a href="Cache.html" title="type parameter in Cache">T</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update()" class="member-name-link">update</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update the cache value and timestamp.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Cache.html" title="class in swervelib.parser">Cache</a><<a href="Cache.html" title="type parameter in Cache">T</a>></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateSupplier(java.util.function.Supplier)" class="member-name-link">updateSupplier</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Cache.html" title="type parameter in Cache">T</a>> supplier)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update the supplier to a new source.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Cache.html" title="class in swervelib.parser">Cache</a><<a href="Cache.html" title="type parameter in Cache">T</a>></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateValidityPeriod(long)" class="member-name-link">updateValidityPeriod</a><wbr>(long validityPeriod)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update the validity period for the cached value, also updates the value.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="value">
|
||||
<h3>value</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="Cache.html" title="type parameter in Cache">T</a></span> <span class="element-name">value</span></div>
|
||||
<div class="block">Cached value.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="supplier">
|
||||
<h3>supplier</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Cache.html" title="type parameter in Cache">T</a>></span> <span class="element-name">supplier</span></div>
|
||||
<div class="block">Supplier for cached value.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="timestamp">
|
||||
<h3>timestamp</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name">timestamp</span></div>
|
||||
<div class="block">Timestamp in microseconds.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="validityPeriod">
|
||||
<h3>validityPeriod</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name">validityPeriod</span></div>
|
||||
<div class="block">Validity period in microseconds.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(java.util.function.Supplier,long)">
|
||||
<h3>Cache</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Cache</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Cache.html" title="type parameter in Cache">T</a>> val,
|
||||
long validityPeriod)</span></div>
|
||||
<div class="block">Cache for arbitrary values.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>val</code> - Value to cache.</dd>
|
||||
<dd><code>validityPeriod</code> - Validity period in milliseconds.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="isStale()">
|
||||
<h3>isStale</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isStale</span>()</div>
|
||||
<div class="block">Return whether the cache is stale.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>The stale state of the cache.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="update()">
|
||||
<h3>update</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Cache.html" title="class in swervelib.parser">Cache</a><<a href="Cache.html" title="type parameter in Cache">T</a>></span> <span class="element-name">update</span>()</div>
|
||||
<div class="block">Update the cache value and timestamp.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="Cache.html" title="class in swervelib.parser"><code>Cache</code></a> used.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="updateSupplier(java.util.function.Supplier)">
|
||||
<h3>updateSupplier</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Cache.html" title="class in swervelib.parser">Cache</a><<a href="Cache.html" title="type parameter in Cache">T</a>></span> <span class="element-name">updateSupplier</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="Cache.html" title="type parameter in Cache">T</a>> supplier)</span></div>
|
||||
<div class="block">Update the supplier to a new source. Updates the value and timestamp as well.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>supplier</code> - new supplier source.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="Cache.html" title="class in swervelib.parser"><code>Cache</code></a> for chaining.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="updateValidityPeriod(long)">
|
||||
<h3>updateValidityPeriod</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Cache.html" title="class in swervelib.parser">Cache</a><<a href="Cache.html" title="type parameter in Cache">T</a>></span> <span class="element-name">updateValidityPeriod</span><wbr><span class="parameters">(long validityPeriod)</span></div>
|
||||
<div class="block">Update the validity period for the cached value, also updates the value.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>validityPeriod</code> - The new validity period in milliseconds.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="Cache.html" title="class in swervelib.parser"><code>Cache</code></a> for chaining.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="getValue()">
|
||||
<h3>getValue</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Cache.html" title="type parameter in Cache">T</a></span> <span class="element-name">getValue</span>()</div>
|
||||
<div class="block">Get the most up to date cached value.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="Cache.html" title="class in swervelib.parser"><code>Cache</code></a> updated to the latest cached version.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -92,28 +92,32 @@ loadScripts(document, 'script');</script>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Cache.html" title="class in swervelib.parser">Cache</a><T></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Cache for frequently requested data.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Swerve Controller configuration class which is used to configure <a href="../SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Swerve Module configuration class which is used to configure <a href="../SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
@@ -59,6 +59,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/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">swervelib.parser.<a href="Cache.html" class="type-name-link" title="class in swervelib.parser">Cache</a><T></li>
|
||||
<li class="circle">swervelib.parser.<a href="PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a></li>
|
||||
<li class="circle">swervelib.parser.<a href="SwerveControllerConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveControllerConfiguration</a></li>
|
||||
<li class="circle">swervelib.parser.<a href="SwerveDriveConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveDriveConfiguration</a></li>
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Fri Jan 26 12:44:25 CST 2024 -->
|
||||
<!-- Generated by javadoc (17) on Fri Feb 02 18:47:23 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-26">
|
||||
<meta name="dc.created" content="2024-02-02">
|
||||
<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">
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user