Updated javadocs

2026-06-19 06:21:40 +00:00 · 2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions
--- a/docs/swervelib/parser/SwerveParser.html
+++ b/docs/swervelib/parser/SwerveParser.html
@@ -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>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="2023-09-01">
+<meta name="dc.created" content="2023-11-09">
 <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">
@@ -156,19 +156,40 @@ loadScripts(document, 'script');</script>
 <div class="block">Check directory structure.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive()" class="member-name-link">createSwerveDrive</a>()</code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(double)" class="member-name-link">createSwerveDrive</a><wbr>(double&nbsp;maxSpeed)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
 </div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a></code></div>
-<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(double,double,double)" class="member-name-link">createSwerveDrive</a><wbr>(double&nbsp;maxSpeed,
+ double&nbsp;angleMotorConversionFactor,
+ double&nbsp;driveMotorConversion)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)" class="member-name-link">createSwerveDrive</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
+ double&nbsp;maxSpeed)</code></div>
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
+</div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)" class="member-name-link">createSwerveDrive</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
+ double&nbsp;maxSpeed,
+ double&nbsp;angleMotorConversionFactor,
+ double&nbsp;driveMotorConversion)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
+</div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a></code></div>
+<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
 <a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a>&nbsp;driveConfiguration)</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
+<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Get the swerve module by the json name.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private com.fasterxml.jackson.databind.JsonNode</code></div>
-<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openJson(java.io.File)" class="member-name-link">openJson</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;file)</code></div>
-<div class="col-last 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>private com.fasterxml.jackson.databind.JsonNode</code></div>
+<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openJson(java.io.File)" class="member-name-link">openJson</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;file)</code></div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Open JSON file.</div>
 </div>
 </div>
@@ -300,11 +321,80 @@ loadScripts(document, 'script');</script>
 </section>
 </li>
 <li>
-<section class="detail" id="createSwerveDrive()">
+<section class="detail" id="createSwerveDrive(double)">
 <h3>createSwerveDrive</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span>()</div>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span><wbr><span class="parameters">(double&nbsp;maxSpeed)</span></div>
 <div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
 <dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>maxSpeed</code> - Maximum speed of the robot in meters per second, used for both angular acceleration used in
+                 <a href="../SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> and drive feedforward in
+                 <a href="../math/SwerveMath.html#createDriveFeedforward(double,double,double)"><code>SwerveMath.createDriveFeedforward(double, double, double)</code></a>.</dd>
+<dt>Returns:</dt>
+<dd><a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> instance.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="createSwerveDrive(double,double,double)">
+<h3>createSwerveDrive</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span><wbr><span class="parameters">(double&nbsp;maxSpeed,
+ double&nbsp;angleMotorConversionFactor,
+ double&nbsp;driveMotorConversion)</span></div>
+<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>maxSpeed</code> - Maximum speed of the robot in meters per second, used for both angular
+                                   acceleration used in <a href="../SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> and drive feedforward in
+                                   <a href="../math/SwerveMath.html#createDriveFeedforward(double,double,double)"><code>SwerveMath.createDriveFeedforward(double, double, double)</code></a>.</dd>
+<dd><code>angleMotorConversionFactor</code> - Angle (AKA azimuth) motor conversion factor to convert motor controller PID loop
+                                   units to degrees, usually created using
+                                   <a href="../math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a>.</dd>
+<dd><code>driveMotorConversion</code> - Drive motor conversion factor to convert motor controller PID loop units to
+                                   meters per rotation, usually created using
+                                   <a href="../math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a>.</dd>
+<dt>Returns:</dt>
+<dd><a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> instance.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)">
+<h3>createSwerveDrive</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span><wbr><span class="parameters">(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
+ double&nbsp;maxSpeed,
+ double&nbsp;angleMotorConversionFactor,
+ double&nbsp;driveMotorConversion)</span></div>
+<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>driveFeedforward</code> - Drive feedforward to use for swerve modules, should be created using
+                                   <a href="../math/SwerveMath.html#createDriveFeedforward(double,double,double)"><code>SwerveMath.createDriveFeedforward(double, double, double)</code></a>.</dd>
+<dd><code>maxSpeed</code> - Maximum speed of the robot in meters per second for normal+angular acceleration
+                                   in <a href="../SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> of the robot.</dd>
+<dd><code>angleMotorConversionFactor</code> - Angle (AKA azimuth) motor conversion factor to convert motor controller PID loop
+                                   units to degrees, usually created using
+                                   <a href="../math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a>.</dd>
+<dd><code>driveMotorConversion</code> - Drive motor conversion factor to convert motor controller PID loop units to
+                                   meters per rotation, usually created using
+                                   <a href="../math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a>.</dd>
+<dt>Returns:</dt>
+<dd><a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> instance.</dd>
+</dl>
+</section>
+</li>
+<li>
+<section class="detail" id="createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)">
+<h3>createSwerveDrive</h3>
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span>&nbsp;<span class="element-name">createSwerveDrive</span><wbr><span class="parameters">(edu.wpi.first.math.controller.SimpleMotorFeedforward&nbsp;driveFeedforward,
+ double&nbsp;maxSpeed)</span></div>
+<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
+<dl class="notes">
+<dt>Parameters:</dt>
+<dd><code>driveFeedforward</code> - Drive feedforward to use for swerve modules, should be created using
+                         <a href="../math/SwerveMath.html#createDriveFeedforward(double,double,double)"><code>SwerveMath.createDriveFeedforward(double, double, double)</code></a>.</dd>
+<dd><code>maxSpeed</code> - Maximum speed of the robot in meters per second for normal+angular acceleration in
+                         <a href="../SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> of the robot</dd>
 <dt>Returns:</dt>
 <dd><a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> instance.</dd>
 </dl>