mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-07-04 07:31:39 +00:00
Added documentation for packages
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveController</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveDrive</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveModule</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>CANCoderSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SparkMaxEncoderSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveAbsoluteEncoder</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.encoders</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.encoders</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,17 +72,29 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../imu/package-summary.html">swervelib.imu</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../math/package-summary.html">swervelib.math</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../motors/package-summary.html">swervelib.motors</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../parser/package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../simulation/package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.encoders Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>ADIS16448Swerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>ADIS16470Swerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>ADXRS450Swerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>AnalogGyroSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>NavXSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>Pigeon2Swerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PigeonSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveIMU</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.imu</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.imu</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">IMUs used for controlling the robot heading. All implement <a href="SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a>.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,17 +72,29 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../encoders/package-summary.html">swervelib.encoders</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../math/package-summary.html">swervelib.math</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../motors/package-summary.html">swervelib.motors</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../parser/package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../simulation/package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.imu Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveKinematics2</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveMath</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveModuleState2</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.math</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.math</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,17 +72,29 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../encoders/package-summary.html">swervelib.encoders</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../imu/package-summary.html">swervelib.imu</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../motors/package-summary.html">swervelib.motors</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../parser/package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../simulation/package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.math Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SparkMaxSwerve.SparkMAX_slotIdx</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SparkMaxSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveMotor</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>TalonFXSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>TalonSRXSwerve</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.motors</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -44,7 +44,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -64,6 +64,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.motors</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -73,17 +76,29 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../encoders/package-summary.html">swervelib.encoders</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../imu/package-summary.html">swervelib.imu</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../math/package-summary.html">swervelib.math</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../parser/package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../simulation/package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.motors Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,17 +72,29 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="encoders/package-summary.html">swervelib.encoders</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="imu/package-summary.html">swervelib.imu</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="math/package-summary.html">swervelib.math</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="motors/package-summary.html">swervelib.motors</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="parser/package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="simulation/package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PIDFConfig</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveControllerConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveDriveConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveModuleConfiguration</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveModulePhysicalCharacteristics</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 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">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PIDFRange</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser.deserializer</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.parser.deserializer</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Deserialize specific variables for outside the parser.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,9 +72,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../json/package-summary.html">swervelib.parser.json</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser.deserializer Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>ControllerPropertiesJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>DeviceJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>ModuleJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>MotorConfigDouble</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>MotorConfigInt</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PIDFPropertiesJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PhysicalPropertiesJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveDriveJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>BoolMotorJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>LocationJson</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser.json.modules</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.parser.json.modules</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">JSON Mapped Configuration types for modules.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,7 +72,9 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib.parser.json</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser.json.modules Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser.json</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.parser.json</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,11 +72,17 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="modules/package-summary.html">swervelib.parser.json.modules</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">JSON Mapped Configuration types for modules.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../deserializer/package-summary.html">swervelib.parser.deserializer</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Deserialize specific variables for outside the parser.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser.json Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.parser</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,21 +72,37 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="deserializer/package-summary.html">swervelib.parser.deserializer</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Deserialize specific variables for outside the parser.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="json/package-summary.html">swervelib.parser.json</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../encoders/package-summary.html">swervelib.encoders</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../imu/package-summary.html">swervelib.imu</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../math/package-summary.html">swervelib.math</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../motors/package-summary.html">swervelib.motors</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../simulation/package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.parser Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveIMUSimulation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>SwerveModuleSimulation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PhysicsSim.SimProfile</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>PhysicsSim</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>TalonFXSimProfile</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>TalonSRXSimProfile</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>VictorSPXSimProfile</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.simulation.ctre</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.simulation.ctre</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">CTRE Physics Simulator.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,7 +72,9 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib.simulation</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.simulation.ctre Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.simulation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
@@ -40,7 +40,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Package: </li>
|
||||
<li>Description | </li>
|
||||
<li><a href="#package-description">Description</a> | </li>
|
||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
||||
</ul>
|
||||
@@ -60,6 +60,9 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.simulation</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<li>
|
||||
@@ -69,19 +72,33 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Package</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="ctre/package-summary.html">swervelib.simulation.ctre</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">CTRE Physics Simulator.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../encoders/package-summary.html">swervelib.encoders</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../imu/package-summary.html">swervelib.imu</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../math/package-summary.html">swervelib.math</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><a href="../motors/package-summary.html">swervelib.motors</a></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><a href="../parser/package-summary.html">swervelib.parser</a></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 21:46:23 CST 2023 -->
|
||||
<!-- Generated by javadoc (17) on Thu Feb 16 22:12:26 CST 2023 -->
|
||||
<title>swervelib.simulation Class Hierarchy</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||||
|
||||
Reference in New Issue
Block a user