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 to 2024.4.8.8

Browse Source
This commit is contained in:
thenetworkgrinch
2024-06-13 17:10:51 -05:00
parent d308949806
commit 073ba711e0
112 changed files with 611 additions and 411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/swervelib/SwerveModule.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Feb 28 13:21:31 CST 2024 -->
<!-- Generated by javadoc (17) on Thu Jun 13 17:09:44 CDT 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-02-28">
<meta name="dc.created" content="2024-06-13">
<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">
@@ -191,14 +191,19 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color">
<div class="block">NT3 Raw drive motor.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></code></div>
<div class="col-second even-row-color"><code><a href="#simModule" class="member-name-link">simModule</a></code></div>
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="#rawDriveVelName" class="member-name-link">rawDriveVelName</a></code></div>
<div class="col-last even-row-color">
<div class="block">NT3 Raw drive motor.</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">
<div class="block">Simulated swerve module.</div>
</div>
<div class="col-first odd-row-color"><code>private boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>private boolean</code></div>
<div class="col-second even-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
<div class="col-last even-row-color">
<div class="block">Encoder synchronization queued.</div>
</div>
</div>
@@ -298,7 +303,7 @@ loadScripts(document, 'script');</script>
<div class="block">Get the Swerve Module state.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToControllers()" class="member-name-link">pushOffsetsToControllers</a>()</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToEncoders()" class="member-name-link">pushOffsetsToEncoders</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Push absolute encoder offset in the memory of the encoder or controller.</div>
</div>
@@ -490,6 +495,13 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="rawDriveVelName">
<h3>rawDriveVelName</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">rawDriveVelName</span></div>
<div class="block">NT3 Raw drive motor.</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>
@@ -497,13 +509,6 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="driveMotorFeedforward">
<h3>driveMotorFeedforward</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.controller.SimpleMotorFeedforward</span>&nbsp;<span class="element-name">driveMotorFeedforward</span></div>
<div class="block">Feedforward for the drive motor during closed loop control.</div>
</section>
</li>
<li>
<section class="detail" id="maxSpeed">
<h3>maxSpeed</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">maxSpeed</span></div>
@@ -511,6 +516,13 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="driveMotorFeedforward">
<h3>driveMotorFeedforward</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">edu.wpi.first.math.controller.SimpleMotorFeedforward</span>&nbsp;<span class="element-name">driveMotorFeedforward</span></div>
<div class="block">Feedforward for the drive motor during closed loop control.</div>
</section>
</li>
<li>
<section class="detail" id="antiJitterEnabled">
<h3>antiJitterEnabled</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">antiJitterEnabled</span></div>
@@ -630,17 +642,6 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="setDrivePIDF(swervelib.parser.PIDFConfig)">
<h3>setDrivePIDF</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDrivePIDF</span><wbr><span class="parameters">(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;config)</span></div>
<div class="block">Set the drive PIDF values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - <a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of that should be set.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getDrivePIDF()">
<h3>getDrivePIDF</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span>&nbsp;<span class="element-name">getDrivePIDF</span>()</div>
@@ -652,10 +653,10 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="setAnglePIDF(swervelib.parser.PIDFConfig)">
<h3>setAnglePIDF</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAnglePIDF</span><wbr><span class="parameters">(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;config)</span></div>
<div class="block">Set the angle/azimuth/steering motor PID</div>
<section class="detail" id="setDrivePIDF(swervelib.parser.PIDFConfig)">
<h3>setDrivePIDF</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDrivePIDF</span><wbr><span class="parameters">(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;config)</span></div>
<div class="block">Set the drive PIDF values.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - <a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of that should be set.</dd>
@@ -674,6 +675,17 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="setAnglePIDF(swervelib.parser.PIDFConfig)">
<h3>setAnglePIDF</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAnglePIDF</span><wbr><span class="parameters">(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;config)</span></div>
<div class="block">Set the angle/azimuth/steering motor PID</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>config</code> - <a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of that should be set.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setDesiredState(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)">
<h3>setDesiredState</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setDesiredState</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState&nbsp;desiredState,
@@ -849,9 +861,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="pushOffsetsToControllers()">
<h3>pushOffsetsToControllers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">pushOffsetsToControllers</span>()</div>
<section class="detail" id="pushOffsetsToEncoders()">
<h3>pushOffsetsToEncoders</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">pushOffsetsToEncoders</span>()</div>
<div class="block">Push absolute encoder offset in the memory of the encoder or controller. Also removes the internal angle offset.</div>
</section>
</li>