Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-07-03 07:21:40 +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

30
docs/index-files/index-9.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>I-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
@@ -98,57 +98,57 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</a>
<h2 class="title">I</h2>
<dl>
<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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#i">i</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">Integral Gain for PID.</div>
</dd>
<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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/DeviceJson.html#id">id</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>
<div class="block">The CAN ID or pin ID of the device.</div>
</dd>
<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>
<dt><span class="memberNameLink"><a href="../swervelib/imu/Pigeon2Swerve.html#imu">imu</a></span> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
<dd>
<div class="block">Pigeon2 IMU device.</div>
</dd>
<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>
<dt><span class="memberNameLink"><a href="../swervelib/imu/PigeonSwerve.html#imu">imu</a></span> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/SwerveDriveJson.html#imu">imu</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dd>
<div class="block">Robot IMU used to determine heading of the robot.</div>
</dd>
<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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveDriveConfiguration.html#imu">imu</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<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>
<dt><span class="memberNameLink"><a href="../swervelib/SwerveDrive.html#imu">imu</a></span> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/ModuleJson.html#inverted">inverted</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
<dd>
<div class="block">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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/SwerveDriveJson.html#invertedIMU">invertedIMU</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveDriveConfiguration.html#invertedIMU">invertedIMU</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SparkMaxSwerve.html#isAttachedAbsoluteEncoder()">isAttachedAbsoluteEncoder()</a></span> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SwerveMotor.html#isAttachedAbsoluteEncoder()">isAttachedAbsoluteEncoder()</a></span> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/motors/SwerveMotor.html#isDriveMotor">isDriveMotor</a></span> - Variable in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in 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>
<dt><span class="memberNameLink"><a href="../swervelib/parser/PIDFConfig.html#iz">iz</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">Integral zone of the PID.</div>
</dd>