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

38
docs/index-files/index-12.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>M-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: M">
<meta name="generator" content="javadoc/IndexWriter">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -93,26 +93,18 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The maximum amount of times the swerve motor will attempt to configure a motor if failures occur.</div>
</dd>
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
<dt><a href="../swervelib/SwerveModule.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Maximum robot speed in feet per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
<dd>
<div class="block">Maximum robot speed in meters per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
<dd>
<div class="block">Max module speed in meters per second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Maximum robot speed in meters per second.</div>
<div class="block">Maximum speed of the drive motors in meters per second.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#maxSpeed" class="member-name-link">maxSpeed</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable speed of the modules, used to adjust the size of the vectors.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Maximum speed of the robot in meters per second.</div>
</dd>
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredChassisSpeeds" class="member-name-link">measuredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
<dd>
<div class="block">The maximum achievable angular velocity of the robot.</div>
@@ -137,11 +129,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">The number of swerve modules</div>
</dd>
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#moduleFeedForwardClosedLoop" class="member-name-link">moduleFeedForwardClosedLoop</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">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
your drive train does not drift towards the direction you are rotating while you translate.</div>
</dd>
<dt><a href="../swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
<dd>
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
@@ -177,15 +164,6 @@ loadScripts(document, 'script');</script>
<div class="block">Enable <code>SwerveModuleState</code> optimizations so the angle is reversed and speed is reversed to ensure the module
never turns more than 90deg.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
<dd>
<div class="block">Angle volt-meter-per-second.</div>
</dd>
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</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 kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
your drive train does not drift towards the direction you are rotating while you translate.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>