Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-07-04 07:31:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated javadocs

Browse Source
This commit is contained in:
thenetworkgrinch
2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: A">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -113,12 +113,12 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Adds a VictorSPX controller to the simulator.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,double)" class="member-name-link">addVisionMeasurement(Pose2d, double, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double)" class="member-name-link">addVisionMeasurement(Pose2d, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
the given timestamp of the vision measurement.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, boolean, Matrix&lt;N3, N1&gt;)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, Matrix&lt;N3, N1&gt;)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
the given timestamp of the vision measurement.</div>
@@ -191,18 +191,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Heading of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#angleEncoderPulsePerRevolution" class="member-name-link">angleEncoderPulsePerRevolution</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">The angle encoder pulse per revolution override.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleEncoderPulsePerRotation" class="member-name-link">angleEncoderPulsePerRotation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle motor encoder pulse per rotation.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleGearRatio" class="member-name-link">angleGearRatio</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle gear ratio.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#angleJoystickRadiusDeadband" class="member-name-link">angleJoystickRadiusDeadband</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">The minimum radius of the angle control joystick to allow for heading adjustment of the robot.</div>
@@ -227,14 +215,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Current limits for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorEncoderPulsePerRevolution" class="member-name-link">angleMotorEncoderPulsePerRevolution</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The integrated encoder pulse per revolution.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#angleMotorFreeSpeedRPM" class="member-name-link">angleMotorFreeSpeedRPM</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">DEPRECATED: No longer needed, tune <a href="../swervelib/parser/json/PhysicalPropertiesJson.html#moduleFeedForwardClosedLoop"><code>PhysicalPropertiesJson.moduleFeedForwardClosedLoop</code></a> instead.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorInverted" class="member-name-link">angleMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">State of inversion of the angle motor.</div>
@@ -263,13 +243,13 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Algebraically apply a deadband using a piece wise function.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Max module speed in meters per second.</div>
<div class="block">The absolute max speed the robot can reach while rotating radians per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Max module speed in meters per second.</div>
<div class="block">The absolute max speed that your robot can reach while translating in meters per second.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: K">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -55,7 +55,7 @@ loadScripts(document, 'script');</script>
<dl class="index">
<dt><a href="../swervelib/SwerveDrive.html#kinematics" class="member-name-link">kinematics</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve Kinematics object utilizing second order kinematics.</div>
<div class="block">Swerve Kinematics object.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: L">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: M">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -93,26 +93,18 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The maximum amount of times the swerve motor will attempt to configure a motor if failures occur.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dt><a href="../swervelib/SwerveModule.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Maximum robot speed in feet per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Maximum robot speed in meters per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Max module speed in meters per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Maximum robot speed in meters per second.</div>
<div class="block">Maximum speed of the drive motors in meters per second.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#maxSpeed" class="member-name-link">maxSpeed</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable speed of the modules, used to adjust the size of the vectors.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Maximum speed of the robot in meters per second.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredChassisSpeeds" class="member-name-link">measuredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable angular velocity of the robot.</div>
@@ -137,11 +129,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The number of swerve modules</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#moduleFeedForwardClosedLoop" class="member-name-link">moduleFeedForwardClosedLoop</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
your drive train does not drift towards the direction you are rotating while you translate.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
@@ -177,15 +164,6 @@ loadScripts(document, 'script');</script>
<div class="block">Enable <code>SwerveModuleState</code> optimizations so the angle is reversed and speed is reversed to ensure the module
never turns more than 90deg.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Angle volt-meter-per-second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
your drive train does not drift towards the direction you are rotating while you translate.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: N">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: O">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -93,13 +93,13 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Open JSON file.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Optimal voltage to compensate to and base feedforward calculations off of.</div>
<div class="block">The voltage to use for the smart motor voltage compensation, default is 12.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Optimal voltage of the robot.</div>
<div class="block">The voltage to use for the smart motor voltage compensation.</div>
</dd>
<dt><a href="../swervelib/parser/PIDFConfig.html#output" class="member-name-link">output</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: P">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -57,6 +57,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Proportional Gain for PID.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Physical characteristics of the swerve drive from physicalproperties.json.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Physical characteristics of the swerve module.</div>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: Q">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: R">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: S">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -101,9 +101,21 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the angle for the module.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setAngleMotorVoltageCompensation(double)" class="member-name-link">setAngleMotorVoltageCompensation(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set chassis speeds with closed-loop velocity control and second order kinematics.</div>
<div class="block">Set chassis speeds with closed-loop velocity control.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
@@ -134,6 +146,18 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the desired state of the swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the conversion factor for the drive motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the conversion factor for the drive motor controller.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setDriveMotorVoltageCompensation(double)" class="member-name-link">setDriveMotorVoltageCompensation(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setGyro(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyro(Rotation3d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object.</div>
@@ -142,6 +166,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the gyro scope offset to a desired known rotation.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setHeadingCorrection(boolean)" class="member-name-link">setHeadingCorrection(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the heading correction capabilities of YAGSL.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
<dd>
<div class="block">Set the motor to be inverted.</div>
@@ -188,15 +216,13 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
<a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> which is used for the
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double,boolean)" class="member-name-link">setMaximumSpeed(double, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double,boolean,double)" class="member-name-link">setMaximumSpeed(double, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
<a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> which is used for the
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState[], boolean)</code></a> function and
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
</dd>
@@ -404,7 +430,7 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#%3Cinit%3E(swervelib.motors.SwerveMotor,int)" class="member-name-link">SparkMaxEncoderSwerve(SwerveMotor, int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
<dd>
<div class="block">Create the <code>AbsoluteEncoder</code> object as a duty cycle.</div>
<div class="block">Create the <a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxEncoderSwerve</code></a> object as a duty cycle from the <code>CANSparkMax</code> motor.</div>
</dd>
<dt><a href="../swervelib/motors/SparkMaxSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
<dd>
@@ -428,8 +454,7 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#stateStdDevs" class="member-name-link">stateStdDevs</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Trustworthiness of the internal model of how motors should be moving Measured in expected standard deviation
(meters of position and degrees of rotation)</div>
<div class="block">Standard deviation of encoders and gyroscopes, usually should not change.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#stopOdometryThread()" class="member-name-link">stopOdometryThread()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
@@ -458,11 +483,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Swerve Controller configuration class which is used to configure <a href="../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Construct the swerve controller configuration.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Construct the swerve controller configuration.</div>
</dd>
@@ -470,7 +495,7 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveDrive(SwerveDriveConfiguration, SwerveControllerConfiguration)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.SwerveControllerConfiguration,double)" class="member-name-link">SwerveDrive(SwerveDriveConfiguration, SwerveControllerConfiguration, double)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Creates a new swerve drivebase subsystem.</div>
</dd>
@@ -482,7 +507,7 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveModuleConfiguration%5B%5D,swervelib.imu.SwerveIMU,double,boolean)" class="member-name-link">SwerveDriveConfiguration(SwerveModuleConfiguration[], SwerveIMU, double, boolean)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveModuleConfiguration%5B%5D,swervelib.imu.SwerveIMU,boolean,edu.wpi.first.math.controller.SimpleMotorFeedforward,swervelib.parser.SwerveModulePhysicalCharacteristics)" class="member-name-link">SwerveDriveConfiguration(SwerveModuleConfiguration[], SwerveIMU, boolean, SimpleMotorFeedforward, SwerveModulePhysicalCharacteristics)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Create swerve drive configuration.</div>
</dd>
@@ -582,7 +607,7 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#%3Cinit%3E(int,swervelib.parser.SwerveModuleConfiguration)" class="member-name-link">SwerveModule(int, SwerveModuleConfiguration)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dt><a href="../swervelib/SwerveModule.html#%3Cinit%3E(int,swervelib.parser.SwerveModuleConfiguration,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">SwerveModule(int, SwerveModuleConfiguration, SimpleMotorFeedforward)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Construct the swerve module and initialize the swerve module motors and absolute encoder.</div>
</dd>
@@ -590,11 +615,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Swerve Module configuration class which is used to configure <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,double,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, boolean, boolean, boolean, double, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, MotorConfigDouble, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, boolean, boolean, boolean, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Construct a configuration object for swerve modules.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, MotorConfigDouble, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Construct a configuration object for swerve modules.</div>
</dd>
@@ -602,11 +627,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(double,double,double,double,double,int,int)" class="member-name-link">SwerveModulePhysicalCharacteristics(double, double, double, double, double, int, int)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(swervelib.parser.json.MotorConfigDouble,double,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(MotorConfigDouble, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Construct the swerve module physical characteristics.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(double,double,double,double,double,int,int,double,double,int,int,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(double, double, double, double, double, int, int, double, double, int, int, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(swervelib.parser.json.MotorConfigDouble,double,double,int,int,double,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(MotorConfigDouble, double, double, int, int, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Construct the swerve module physical characteristics.</div>
</dd>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: T">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: B">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: U">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: V">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -93,8 +93,9 @@ the order they are declared.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Trustworthiness of the vision system Measured in expected standard deviation (meters of position and degrees of
rotation)</div>
<div class="block">The standard deviation of the vision measurement, for best accuracy calculate the standard deviation at 2 or more
points and fit a line to it and modify this using <a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,edu.wpi.first.math.Matrix)"><code>SwerveDrive.addVisionMeasurement(Pose2d, double, Matrix)</code></a>
with the calculated optimal standard deviation.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: W">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -53,14 +53,6 @@ loadScripts(document, 'script');</script>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:W">W</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#wheelDiameter" class="member-name-link">wheelDiameter</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Wheel diameter in inches.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#wheelDiameter" class="member-name-link">wheelDiameter</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Wheel diameter in meters.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#wheelGripCoefficientOfFriction" class="member-name-link">wheelGripCoefficientOfFriction</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">The grip tape coefficient of friction on carpet.</div>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: X">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: Y">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: Z">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<title>_-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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: _">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: C">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -341,6 +341,24 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#%3Cinit%3E()" class="member-name-link">ControllerPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Conversion factor for the module, if different from the one in swervedrive.json</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Conversion factor applied to the motor controllers PID loops.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The conversion factors for the drive and angle motors, created by
<a href="../swervelib/math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a> and
<a href="../swervelib/math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a>.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#conversionFactors" class="member-name-link">conversionFactors</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Conversion factor for drive motor onboard PID's and angle PID's.</div>
</dd>
<dt><a href="../swervelib/motors/TalonFXSwerve.html#convertToNativeSensorUnits(double,double)" class="member-name-link">convertToNativeSensorUnits(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
<dd>
<div class="block">Convert the setpoint into native sensor units.</div>
@@ -349,11 +367,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Convert the setpoint into native sensor units.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#createControllerConfiguration(swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">createControllerConfiguration(SwerveDriveConfiguration)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#createControllerConfiguration(swervelib.parser.SwerveDriveConfiguration,double)" class="member-name-link">createControllerConfiguration(SwerveDriveConfiguration, double)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">Create the <a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> based on parsed and given data.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#createDriveFeedforward()" class="member-name-link">createDriveFeedforward()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dt><a href="../swervelib/math/SwerveMath.html#createDriveFeedforward(double,double,double)" class="member-name-link">createDriveFeedforward(double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
<dd>
<div class="block">Create the drive feedforward for swerve modules.</div>
</dd>
@@ -369,11 +387,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Create a <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> from the data port on the motor controller.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">createModuleConfiguration(PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, String)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dt><a href="../swervelib/parser/json/ModuleJson.html#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">createModuleConfiguration(PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, String)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Create the swerve module configuration based off of parsed data.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#createModules(swervelib.parser.SwerveModuleConfiguration%5B%5D)" class="member-name-link">createModules(SwerveModuleConfiguration[])</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#createModules(swervelib.parser.SwerveModuleConfiguration%5B%5D,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">createModules(SwerveModuleConfiguration[], SimpleMotorFeedforward)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Create modules based off of the SwerveModuleConfiguration.</div>
</dd>
@@ -381,7 +399,7 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Create a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> from the given configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#createPhysicalProperties(double)" class="member-name-link">createPhysicalProperties(double)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#createPhysicalProperties()" class="member-name-link">createPhysicalProperties()</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Create the physical characteristics based off the parsed data.</div>
</dd>
@@ -389,7 +407,19 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Create a PIDController from the PID values.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive()" class="member-name-link">createSwerveDrive()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(double)" class="member-name-link">createSwerveDrive(double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(double,double,double)" class="member-name-link">createSwerveDrive(double, double, double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)" class="member-name-link">createSwerveDrive(SimpleMotorFeedforward, double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)" class="member-name-link">createSwerveDrive(SimpleMotorFeedforward, double, double, double)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
</dd>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: D">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -71,10 +71,6 @@ loadScripts(document, 'script');</script>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#%3Cinit%3E()" class="member-name-link">DeviceJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/SwerveDrive.html#disableSecondOrderKinematics()" class="member-name-link">disableSecondOrderKinematics()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Disable second order kinematics.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Drive motor device configuration.</div>
@@ -99,17 +95,17 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The primary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean,boolean)" class="member-name-link">drive(Translation2d, double, boolean, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">drive(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Secondary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.kinematics.ChassisSpeeds,boolean)" class="member-name-link">drive(ChassisSpeeds, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The primary method for controlling the drivebase.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveEncoderPulsePerRotation" class="member-name-link">driveEncoderPulsePerRotation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">driveFieldOriented(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Drive motor encoder pulse per rotation.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveGearRatio" class="member-name-link">driveGearRatio</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Drive gear ratio.</div>
<div class="block">Secondary method of controlling the drive base given velocity and adjusting it for field oriented use.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: E">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -53,18 +53,6 @@ loadScripts(document, 'script');</script>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:E">E</h2>
<dl class="index">
<dt><a href="../swervelib/SwerveDrive.html#enableSecondOrderKinematics()" class="member-name-link">enableSecondOrderKinematics()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Enable second order kinematics for tracking purposes but completely untuned.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#enableSecondOrderKinematics(double)" class="member-name-link">enableSecondOrderKinematics(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Enable second order kinematics for simulation and modifying the feedforward.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#enableSecondOrderKinematics(int)" class="member-name-link">enableSecondOrderKinematics(int)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Enable second order kinematics with calculated values for the feedforward and return the value used.</div>
</dd>
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
<dd>
<div class="block">Encoder as Analog Input.</div>
@@ -97,10 +85,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Absolute encoder device configuration.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#encoderPulsePerRotation" class="member-name-link">encoderPulsePerRotation</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Encoder pulse per rotation for non-integrated encoders.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>
</div>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: F">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: G">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -53,10 +53,6 @@ loadScripts(document, 'script');</script>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a>
<h2 class="title" id="I:G">G</h2>
<dl class="index">
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#gearRatio" class="member-name-link">gearRatio</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">Gear ratio for the motors, number of times the motor has to spin before the wheel rotates a single time.</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>
@@ -289,14 +285,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Get the position of the swerve module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#getPositionEncoderConversion(boolean)" class="member-name-link">getPositionEncoderConversion(boolean)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Get the encoder conversion for position encoders.</div>
</dd>
<dt><a href="../swervelib/parser/json/DeviceJson.html#getPulsePerRotation(int)" class="member-name-link">getPulsePerRotation(int)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">Get the encoder pulse per rotation based off of the encoder type.</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>
@@ -411,11 +399,11 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Get the swerve module poses and on the field relative to the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
</dd>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
<dd>
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
</dd>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: H">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -61,6 +61,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Calculate the angular velocity given the current and target heading angle in radians.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#headingCorrection" class="member-name-link">headingCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Whether to correct heading when driving translationally.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#headingPIDF" class="member-name-link">headingPIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">PIDF for the heading of the robot.</div>

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<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="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: I">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">