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 javadocs

Browse Source
This commit is contained in:
thenetworkgrinch
2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/index-files/index-1.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<title>A-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2023-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="index: A">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -113,12 +113,12 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Adds a VictorSPX controller to the simulator.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,double)" class="member-name-link">addVisionMeasurement(Pose2d, double, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double)" class="member-name-link">addVisionMeasurement(Pose2d, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
the given timestamp of the vision measurement.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, boolean, Matrix&lt;N3, N1&gt;)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, Matrix&lt;N3, N1&gt;)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
the given timestamp of the vision measurement.</div>
@@ -191,18 +191,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Heading of the robot.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html#angleEncoderPulsePerRevolution" class="member-name-link">angleEncoderPulsePerRevolution</a> - 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">The angle encoder pulse per revolution override.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleEncoderPulsePerRotation" class="member-name-link">angleEncoderPulsePerRotation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle motor encoder pulse per rotation.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleGearRatio" class="member-name-link">angleGearRatio</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
<dd>
<div class="block">Angle gear ratio.</div>
</dd>
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#angleJoystickRadiusDeadband" class="member-name-link">angleJoystickRadiusDeadband</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
<dd>
<div class="block">The minimum radius of the angle control joystick to allow for heading adjustment of the robot.</div>
@@ -227,14 +215,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Current limits for the Swerve Module.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorEncoderPulsePerRevolution" class="member-name-link">angleMotorEncoderPulsePerRevolution</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">The integrated encoder pulse per revolution.</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#angleMotorFreeSpeedRPM" class="member-name-link">angleMotorFreeSpeedRPM</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
<dd>
<div class="block">DEPRECATED: No longer needed, tune <a href="../swervelib/parser/json/PhysicalPropertiesJson.html#moduleFeedForwardClosedLoop"><code>PhysicalPropertiesJson.moduleFeedForwardClosedLoop</code></a> instead.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorInverted" class="member-name-link">angleMotorInverted</a> - 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 angle motor.</div>
@@ -263,13 +243,13 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Algebraically apply a deadband using a piece wise function.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Max module speed in meters per second.</div>
<div class="block">The absolute max speed the robot can reach while rotating radians per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Max module speed in meters per second.</div>
<div class="block">The absolute max speed that your robot can reach while translating in meters per second.</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">Q</a>&nbsp;<a href="index-17.html">R</a>&nbsp;<a href="index-18.html">S</a>&nbsp;<a href="index-19.html">T</a>&nbsp;<a href="index-20.html">U</a>&nbsp;<a href="index-21.html">V</a>&nbsp;<a href="index-22.html">W</a>&nbsp;<a href="index-23.html">X</a>&nbsp;<a href="index-24.html">Y</a>&nbsp;<a href="index-25.html">Z</a>&nbsp;<a href="index-26.html">_</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant&nbsp;Field&nbsp;Values</a></main>