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

Update YAGSL to handle controls better

Browse Source
This commit is contained in:
thenetworkgrinch
2023-04-08 12:31:07 -05:00
parent d37a38bb7b
commit 5b38929c48
123 changed files with 871 additions and 805 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
docs/swervelib/parser/SwerveModuleConfiguration.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Apr 05 08:59:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Sat Apr 08 12:30:47 CDT 2023 -->
<title>SwerveModuleConfiguration</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-04-05">
<meta name="dc.created" content="2023-04-08">
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModuleConfiguration">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -101,64 +101,69 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color">
<div class="block">Whether the absolute encoder is inverted.</div>
</div>
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#angleKV" class="member-name-link">angleKV</a></code></div>
<div class="col-first even-row-color"><code><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second even-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
<div class="col-last even-row-color">
<div class="block">Angle volt-meter-per-second.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second odd-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The drive motor and angle motor of this swerve module.</div>
</div>
<div class="col-first even-row-color"><code>double</code></div>
<div class="col-second even-row-color"><code><a href="#angleMotorEncoderPulsePerRevolution" class="member-name-link">angleMotorEncoderPulsePerRevolution</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>double</code></div>
<div class="col-second odd-row-color"><code><a href="#angleMotorEncoderPulsePerRevolution" class="member-name-link">angleMotorEncoderPulsePerRevolution</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The integrated encoder pulse per revolution.</div>
</div>
<div class="col-first odd-row-color"><code>final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#angleMotorInverted" class="member-name-link">angleMotorInverted</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#angleMotorInverted" class="member-name-link">angleMotorInverted</a></code></div>
<div class="col-last even-row-color">
<div class="block">State of inversion of the angle motor.</div>
</div>
<div class="col-first even-row-color"><code>final double</code></div>
<div class="col-second even-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code>final double</code></div>
<div class="col-second odd-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Angle offset in degrees for the Swerve Module.</div>
</div>
<div class="col-first odd-row-color"><code><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
<div class="col-second odd-row-color"><code><a href="#anglePIDF" class="member-name-link">anglePIDF</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
<div class="col-second even-row-color"><code><a href="#anglePIDF" class="member-name-link">anglePIDF</a></code></div>
<div class="col-last even-row-color">
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
</div>
<div class="col-first even-row-color"><code><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second even-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
<div class="col-last even-row-color">
<div class="col-first odd-row-color"><code><a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
<div class="col-second odd-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The drive motor and angle motor of this swerve module.</div>
</div>
<div class="col-first odd-row-color"><code>final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#driveMotorInverted" class="member-name-link">driveMotorInverted</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#driveMotorInverted" class="member-name-link">driveMotorInverted</a></code></div>
<div class="col-last even-row-color">
<div class="block">State of inversion of the drive motor.</div>
</div>
<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="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="block">Maximum robot speed in meters per second.</div>
</div>
<div class="col-first odd-row-color"><code>edu.wpi.first.math.geometry.Translation2d</code></div>
<div class="col-second odd-row-color"><code><a href="#moduleLocation" class="member-name-link">moduleLocation</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code>edu.wpi.first.math.geometry.Translation2d</code></div>
<div class="col-second even-row-color"><code><a href="#moduleLocation" class="member-name-link">moduleLocation</a></code></div>
<div class="col-last even-row-color">
<div class="block">Swerve module location relative to the robot.</div>
</div>
<div class="col-first even-row-color"><code><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></code></div>
<div class="col-second even-row-color"><code><a href="#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a></code></div>
<div class="col-first odd-row-color"><code>double</code></div>
<div class="col-second odd-row-color"><code><a href="#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Angle volt-meter-per-second.</div>
</div>
<div class="col-first even-row-color"><code><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="#name" class="member-name-link">name</a></code></div>
<div class="col-last even-row-color">
<div class="block">Name for the swerve module for telemetry.</div>
</div>
<div class="col-first odd-row-color"><code><a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></code></div>
<div class="col-second odd-row-color"><code><a href="#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Physical characteristics of the swerve module.</div>
</div>
<div class="col-first odd-row-color"><code><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
<div class="col-second odd-row-color"><code><a href="#velocityPIDF" class="member-name-link">velocityPIDF</a></code></div>
<div class="col-last odd-row-color">
<div class="col-first even-row-color"><code><a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
<div class="col-second even-row-color"><code><a href="#velocityPIDF" class="member-name-link">velocityPIDF</a></code></div>
<div class="col-last even-row-color">
<div class="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
</div>
</div>
@@ -172,20 +177,7 @@ loadScripts(document, 'script');</script>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics)" class="member-name-link">SwerveModuleConfiguration</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;driveMotor,
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;angleMotor,
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;absoluteEncoder,
double&nbsp;angleOffset,
double&nbsp;xMeters,
double&nbsp;yMeters,
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;anglePIDF,
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;velocityPIDF,
double&nbsp;maxSpeed,
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics)</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a configuration object for swerve modules.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,double,double)" class="member-name-link">SwerveModuleConfiguration</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;driveMotor,
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,double,java.lang.String)" class="member-name-link">SwerveModuleConfiguration</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;driveMotor,
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;angleMotor,
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;absoluteEncoder,
double&nbsp;angleOffset,
@@ -199,7 +191,21 @@ loadScripts(document, 'script');</script>
boolean&nbsp;driveMotorInverted,
boolean&nbsp;angleMotorInverted,
double&nbsp;angleMotorEncoderPulsePerRevolution,
double&nbsp;angleMotorFreeSpeedRPM)</code></div>
<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>&nbsp;name)</code></div>
<div class="col-last even-row-color">
<div class="block">Construct a configuration object for swerve modules.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">SwerveModuleConfiguration</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;driveMotor,
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;angleMotor,
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;absoluteEncoder,
double&nbsp;angleOffset,
double&nbsp;xMeters,
double&nbsp;yMeters,
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;anglePIDF,
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;velocityPIDF,
double&nbsp;maxSpeed,
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics,
<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>&nbsp;name)</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a configuration object for swerve modules.</div>
</div>
@@ -294,9 +300,9 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="angleKV">
<h3>angleKV</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">angleKV</span></div>
<section class="detail" id="moduleSteerFFCL">
<h3>moduleSteerFFCL</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">moduleSteerFFCL</span></div>
<div class="block">Angle volt-meter-per-second.</div>
</section>
</li>
@@ -342,6 +348,13 @@ loadScripts(document, 'script');</script>
<div class="block">The Absolute Encoder for the swerve module.</div>
</section>
</li>
<li>
<section class="detail" id="name">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">public</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">name</span></div>
<div class="block">Name for the swerve module for telemetry.</div>
</section>
</li>
</ul>
</section>
</li>
@@ -351,7 +364,7 @@ loadScripts(document, 'script');</script>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,double,double)">
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,double,java.lang.String)">
<h3>SwerveModuleConfiguration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveModuleConfiguration</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;driveMotor,
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;angleMotor,
@@ -367,7 +380,7 @@ loadScripts(document, 'script');</script>
boolean&nbsp;driveMotorInverted,
boolean&nbsp;angleMotorInverted,
double&nbsp;angleMotorEncoderPulsePerRevolution,
double&nbsp;angleMotorFreeSpeedRPM)</span></div>
<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>&nbsp;name)</span></div>
<div class="block">Construct a configuration object for swerve modules.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -385,12 +398,11 @@ loadScripts(document, 'script');</script>
<dd><code>maxSpeed</code> - Maximum speed in meters per second.</dd>
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
<dd><code>angleMotorEncoderPulsePerRevolution</code> - The encoder pulse per revolution for the angle motor encoder.</dd>
<dd><code>angleMotorFreeSpeedRPM</code> - The free speed RPM of the angle motor.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics)">
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)">
<h3>SwerveModuleConfiguration</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveModuleConfiguration</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;driveMotor,
<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;angleMotor,
@@ -401,7 +413,8 @@ loadScripts(document, 'script');</script>
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;anglePIDF,
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a>&nbsp;velocityPIDF,
double&nbsp;maxSpeed,
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics)</span></div>
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics,
<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>&nbsp;name)</span></div>
<div class="block">Construct a configuration object for swerve modules. Assumes the absolute encoder and drive motor are not
inverted.</div>
<dl class="notes">
@@ -416,6 +429,7 @@ loadScripts(document, 'script');</script>
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
<dd><code>maxSpeed</code> - Maximum robot speed in meters per second.</dd>
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
<dd><code>name</code> - Name for the module.</dd>
</dl>
</section>
</li>