Updated swervelib

This commit is contained in:
thenetworkgrinch
2023-02-13 14:37:05 -06:00
parent f929f12e41
commit 6a40ec018e
151 changed files with 24641 additions and 5320 deletions

View File

@@ -2,20 +2,21 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.13) on Tue Jan 31 10:51:37 CST 2023 -->
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 14:36:54 CST 2023 -->
<title>I-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-01-31">
<meta name="dc.created" content="2023-02-13">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../jquery/jquery-ui.js"></script>
<script type="text/javascript" src="../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
@@ -48,7 +49,6 @@ loadScripts(document, 'script');</script>
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
@@ -93,33 +93,67 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</nav>
</header>
<main role="main">
<div class="contentContainer"><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">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a><a id="I:I">
<div class="contentContainer"><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">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">X</a>&nbsp;<a href="index-23.html">Y</a>&nbsp;<a href="index-24.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a><a id="I:I">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#initSendable(edu.wpi.first.util.sendable.SendableBuilder)">initSendable(SendableBuilder)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#i">i</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Initializes this <code>Sendable</code> object.</div>
<div class="block">Integral Gain for PID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#initSendable(edu.wpi.first.util.sendable.SendableBuilder)">initSendable(SendableBuilder)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/DeviceJson.html#id">id</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/DeviceJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">Initializes this <code>Sendable</code> object.</div>
<div class="block">The CAN ID or pin ID of the device.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#instances">instances</a></span> - Static variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html#imu">imu</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.imu.<a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Count of SwerveModule instances created.</div>
<div class="block">Pigeon2 IMU device.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#invertedDrive">invertedDrive</a></span> - Variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html#imu">imu</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.imu.<a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu">PigeonSwerve</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/SwerveDriveJson.html#imu">imu</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/SwerveDriveJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>
<div class="block">Inverted drive motor.</div>
<div class="block">Robot IMU used to determine heading of the robot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#invertedTurn">invertedTurn</a></span> - Variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveDriveConfiguration.html#imu">imu</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveDriveConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Inverted turning motor.</div>
<div class="block">Swerve IMU</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html#imu">imu</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.<a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/ModuleJson.html#inverted">inverted</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/ModuleJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">Defines which motors are inverted.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/SwerveDriveJson.html#invertedIMU">invertedIMU</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/SwerveDriveJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>
<div class="block">Invert the IMU of the robot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveDriveConfiguration.html#invertedIMU">invertedIMU</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveDriveConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Invert the imu measurements.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html#isAttachedAbsoluteEncoder()">isAttachedAbsoluteEncoder()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html#isAttachedAbsoluteEncoder()">isAttachedAbsoluteEncoder()</a></span> - Method in class frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html#isDriveMotor">isDriveMotor</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.motors">SwerveMotor</a></dt>
<dd>
<div class="block">Whether the swerve motor is a drive motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#iz">iz</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Integral zone of the PID.</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">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></div>
<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">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">X</a>&nbsp;<a href="index-23.html">Y</a>&nbsp;<a href="index-24.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></div>
</main>
<footer role="contentinfo">
<nav role="navigation">
@@ -135,7 +169,6 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>