Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-06-19 06:21:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
thenetworkgrinch
2024-01-17 09:18:38 -06:00
parent 1ca3db242c
commit 889c85172f
108 changed files with 1609 additions and 370 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/swervelib/SwerveModule.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>SwerveModule</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="2024-01-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib, class: SwerveModule">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -116,26 +116,36 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color">
<div class="block">Swerve Motors.</div>
</div>
<div class="col-first odd-row-color"><code>edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
<div class="col-second odd-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div>
<div class="col-first odd-row-color"><code>private final <a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#encoderOffsetWarning" class="member-name-link">encoderOffsetWarning</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
</div>
<div class="col-first even-row-color"><code>edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
<div class="col-second even-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div>
<div class="col-last even-row-color">
<div class="block">Feedforward for drive motor during closed loop control.</div>
</div>
<div class="col-first even-row-color"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
<div class="col-second even-row-color"><code><a href="#lastState" class="member-name-link">lastState</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
<div class="col-second odd-row-color"><code><a href="#lastState" class="member-name-link">lastState</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Last swerve module state applied.</div>
</div>
<div class="col-first odd-row-color"><code>double</code></div>
<div class="col-second odd-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
<div class="col-last even-row-color">
<div class="block">Maximum speed of the drive motors in meters per second.</div>
</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><code><a href="#moduleNumber" class="member-name-link">moduleNumber</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>int</code></div>
<div class="col-second odd-row-color"><code><a href="#moduleNumber" class="member-name-link">moduleNumber</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Module number for kinematics, usually 0 to 3.</div>
</div>
<div class="col-first even-row-color"><code>private final <a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#noEncoderWarning" class="member-name-link">noEncoderWarning</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</div>
</div>
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></code></div>
<div class="col-second odd-row-color"><code><a href="#simModule" class="member-name-link">simModule</a></code></div>
<div class="col-last odd-row-color">
@@ -320,6 +330,20 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="encoderOffsetWarning">
<h3>encoderOffsetWarning</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">encoderOffsetWarning</span></div>
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
</section>
</li>
<li>
<section class="detail" id="noEncoderWarning">
<h3>noEncoderWarning</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">noEncoderWarning</span></div>
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</div>
</section>
</li>
<li>
<section class="detail" id="moduleNumber">
<h3>moduleNumber</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">moduleNumber</span></div>