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

40
docs/index-files/index-4.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>D-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-02-13">
@@ -98,78 +98,78 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</a>
<h2 class="title">D</h2>
<dl>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/PIDFConfig.html#d">d</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#d">d</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">Derivative Gain for PID.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/math/SwerveKinematics2.html#desaturateWheelSpeeds(frc.robot.subsystems.swervedrive2.swervelib.math.SwerveModuleState2%5B%5D,double)">desaturateWheelSpeeds(SwerveModuleState2[], double)</a></span> - Static method in class frc.robot.subsystems.swervedrive2.swervelib.math.<a href="../frc/robot/subsystems/swervedrive2/swervelib/math/SwerveKinematics2.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math">SwerveKinematics2</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/math/SwerveKinematics2.html#desaturateWheelSpeeds(swervelib.math.SwerveModuleState2%5B%5D,double)">desaturateWheelSpeeds(SwerveModuleState2[], double)</a></span> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
<dd>
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/math/SwerveKinematics2.html#desaturateWheelSpeeds(frc.robot.subsystems.swervedrive2.swervelib.math.SwerveModuleState2%5B%5D,edu.wpi.first.math.kinematics.ChassisSpeeds,double,double,double)">desaturateWheelSpeeds(SwerveModuleState2[], ChassisSpeeds, double, double, double)</a></span> - Static method in class frc.robot.subsystems.swervedrive2.swervelib.math.<a href="../frc/robot/subsystems/swervedrive2/swervelib/math/SwerveKinematics2.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.math">SwerveKinematics2</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/math/SwerveKinematics2.html#desaturateWheelSpeeds(swervelib.math.SwerveModuleState2%5B%5D,edu.wpi.first.math.kinematics.ChassisSpeeds,double,double,double)">desaturateWheelSpeeds(SwerveModuleState2[], ChassisSpeeds, double, double, double)</a></span> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
<dd>
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well as getting rid of
joystick saturation at edges of joystick.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/DeviceJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json"><span class="typeNameLink">DeviceJson</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/DeviceJson.html" title="class in swervelib.parser.json"><span class="typeNameLink">DeviceJson</span></a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block">Device JSON parsed class.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/DeviceJson.html#%3Cinit%3E()">DeviceJson()</a></span> - Constructor for 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#%3Cinit%3E()">DeviceJson()</a></span> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/ModuleJson.html#drive">drive</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#drive">drive</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">Drive motor device configuration.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/BoolMotorJson.html#drive">drive</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/modules/BoolMotorJson.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json.modules">BoolMotorJson</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/modules/BoolMotorJson.html#drive">drive</a></span> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
<dd>
<div class="block">Drive motor inversion state.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigDouble.html#drive">drive</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigDouble.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">MotorConfigDouble</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/MotorConfigDouble.html#drive">drive</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
<dd>
<div class="block">Drive motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigInt.html#drive">drive</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.json.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/MotorConfigInt.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser.json">MotorConfigInt</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/json/MotorConfigInt.html#drive">drive</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
<dd>
<div class="block">Drive motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/json/PIDFPropertiesJson.html#drive">drive</a></span> - Variable in 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#drive">drive</a></span> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
<dd>
<div class="block">The PIDF with Integral Zone used for the drive motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)">drive(Translation2d, double, boolean, boolean)</a></span> - Method 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#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)">drive(Translation2d, double, boolean, boolean)</a></span> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">The primary method for controlling the drivebase.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveEncoderPulsePerRotation">driveEncoderPulsePerRotation</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveEncoderPulsePerRotation">driveEncoderPulsePerRotation</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Drive motor encoder pulse per rotation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveGearRatio">driveGearRatio</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveGearRatio">driveGearRatio</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Drive gear ratio.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModuleConfiguration.html#driveMotor">driveMotor</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#driveMotor">driveMotor</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">The drive motor and angle motor of this swerve module.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html#driveMotor">driveMotor</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.<a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/SwerveModule.html#driveMotor">driveMotor</a></span> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Swerve Motors.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorCurrentLimit">driveMotorCurrentLimit</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorCurrentLimit">driveMotorCurrentLimit</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Current limits for the Swerve Module.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModuleConfiguration.html#driveMotorInverted">driveMotorInverted</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#driveMotorInverted">driveMotorInverted</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">State of inversion of the drive motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorRampRate">driveMotorRampRate</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.parser.<a href="../frc/robot/subsystems/swervedrive2/swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in frc.robot.subsystems.swervedrive2.swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorRampRate">driveMotorRampRate</a></span> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html#dt">dt</a></span> - Variable in class frc.robot.subsystems.swervedrive2.swervelib.<a href="../frc/robot/subsystems/swervedrive2/swervelib/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive2.swervelib">SwerveModule</a></dt>
<dt><span class="memberNameLink"><a href="../swervelib/SwerveModule.html#dt">dt</a></span> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Current state.</div>
</dd>