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

Updated docs

Browse Source
This commit is contained in:
thenetworkgrinch
2023-02-13 15:03:55 -06:00
parent 9f8c3f6b49
commit e8d248b68a
161 changed files with 2589 additions and 37454 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 14:36:54 CST 2023 -->
<!-- Generated by javadoc (11.0.17) on Mon Feb 13 15:03:24 CST 2023 -->
<title>P-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
@@ -98,90 +98,89 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</a>
<h2 class="title">P</h2>
<dl>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#p">p</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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#p">p</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Proportional Gain for PID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModuleConfiguration.html#physicalCharacteristics">physicalCharacteristics</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModuleConfiguration.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModuleConfiguration</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveModuleConfiguration.html#physicalCharacteristics">physicalCharacteristics</a></span> - 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>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveParser.html#physicalPropertiesJson">physicalPropertiesJson</a></span> - Static variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveParser</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveParser.html#physicalPropertiesJson">physicalPropertiesJson</a></span> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Parsed modules/physicalproperties.json</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PhysicalPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">PhysicalPropertiesJson</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser.json</a></dt>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">PhysicalPropertiesJson</span></a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
<div class="block"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PhysicalPropertiesJson.html#%3Cinit%3E()">PhysicalPropertiesJson()</a></span> - Constructor for class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PhysicalPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#%3Cinit%3E()">PhysicalPropertiesJson()</a></span> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.html#pid">pid</a></span> - Variable 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>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SparkMaxSwerve.html#pid">pid</a></span> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
<dd>
<div class="block">Closed-loop PID controller.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser"><span class="typeNameLink">PIDFConfig</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser</a></dt>
<dt><a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser"><span class="typeNameLink">PIDFConfig</span></a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
<dd>
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#%3Cinit%3E()">PIDFConfig()</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E()">PIDFConfig()</a></span> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">Used when parsing PIDF values from JSON.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double)">PIDFConfig(double, double)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double)">PIDFConfig(double, double)</a></span> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double)">PIDFConfig(double, double, double)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double)">PIDFConfig(double, double, double)</a></span> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double)">PIDFConfig(double, double, double, double)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double)">PIDFConfig(double, double, double, double)</a></span> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double,double)">PIDFConfig(double, double, double, double, double)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double,double)">PIDFConfig(double, double, double, double, double)</a></span> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
<dd>
<div class="block">PIDF Config constructor to contain the values.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveParser.html#pidfPropertiesJson">pidfPropertiesJson</a></span> - Static variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveParser</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveParser.html#pidfPropertiesJson">pidfPropertiesJson</a></span> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
<dd>
<div class="block">Parsed modules/pidfproperties.json</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PIDFPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">PIDFPropertiesJson</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser.json</a></dt>
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">PIDFPropertiesJson</span></a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle
motor.</div>
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PIDFPropertiesJson.html#%3Cinit%3E()">PIDFPropertiesJson()</a></span> - Constructor for class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PIDFPropertiesJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/PIDFPropertiesJson.html#%3Cinit%3E()">PIDFPropertiesJson()</a></span> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/PIDFRange.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer"><span class="typeNameLink">PIDFRange</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer</a></dt>
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer"><span class="typeNameLink">PIDFRange</span></a> - Class in <a href="../swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></dt>
<dd>
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/PIDFRange.html#%3Cinit%3E()">PIDFRange()</a></span> - Constructor for class frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/deserializer/PIDFRange.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.deserializer">PIDFRange</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/deserializer/PIDFRange.html#%3Cinit%3E()">PIDFRange()</a></span> - Constructor for class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu"><span class="typeNameLink">Pigeon2Swerve</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.imu</a></dt>
<dt><a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu"><span class="typeNameLink">Pigeon2Swerve</span></a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">SwerveIMU interface for the Pigeon2</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int)">Pigeon2Swerve(int)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int)">Pigeon2Swerve(int)</a></span> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Generate the SwerveIMU for pigeon.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int,java.lang.String)">Pigeon2Swerve(int, String)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int,java.lang.String)">Pigeon2Swerve(int, String)</a></span> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Generate the SwerveIMU for pigeon.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.imu"><span class="typeNameLink">PigeonSwerve</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/package-summary.html">frc.robot.subsystems.swervedrive2.swervelib.imu</a></dt>
<dt><a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu"><span class="typeNameLink">PigeonSwerve</span></a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
<dd>
<div class="block">SwerveIMU interface for the Pigeon.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/imu/PigeonSwerve.html#%3Cinit%3E(int)">PigeonSwerve(int)</a></span> - Constructor for 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>
<dt><span class="memberNameLink"><a href="../swervelib/imu/PigeonSwerve.html#%3Cinit%3E(int)">PigeonSwerve(int)</a></span> - Constructor for class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
<dd>
<div class="block">Generate the SwerveIMU for pigeon.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Position">Position</a></span> - frc.robot.subsystems.swervedrive2.swervelib.motors.<a href="../frc/robot/subsystems/swervedrive2/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive2.swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Position">Position</a></span> - swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
<dd>&nbsp;</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">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>