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

Added overridable configuration options in module json

Browse Source
This commit is contained in:
thenetworkgrinch
2023-02-23 22:16:09 -06:00
parent f5c63d5c6f
commit b484ed9bc0
108 changed files with 234 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Thu Feb 23 21:12:10 CST 2023 -->
<!-- Generated by javadoc (17) on Thu Feb 23 22:15:41 CST 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">
@@ -111,49 +111,54 @@ loadScripts(document, 'script');</script>
<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>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-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="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="block">State of inversion of the angle motor.</div>
</div>
<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="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="block">Angle offset in degrees for the Swerve Module.</div>
</div>
<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="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="block">PIDF configuration options for the angle motor closed-loop PID controller.</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="#driveMotor" class="member-name-link">driveMotor</a></code></div>
<div class="col-last odd-row-color">
<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="block">The drive motor and angle motor of this swerve module.</div>
</div>
<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="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="block">State of inversion of the drive motor.</div>
</div>
<div class="col-first odd-row-color"><code>final 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>final 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 robot speed in meters per second.</div>
</div>
<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="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="block">Swerve module location relative to the robot.</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="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-last even-row-color">
<div class="block">Physical characteristics of the swerve module.</div>
</div>
<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="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="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
</div>
</div>
@@ -180,7 +185,7 @@ loadScripts(document, 'script');</script>
<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)" 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 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,
<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,
@@ -192,7 +197,9 @@ loadScripts(document, 'script');</script>
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics,
boolean&nbsp;absoluteEncoderInverted,
boolean&nbsp;driveMotorInverted,
boolean&nbsp;angleMotorInverted)</code></div>
boolean&nbsp;angleMotorInverted,
double&nbsp;angleMotorEncoderPulsePerRevolution,
double&nbsp;angleMotorFreeSpeedRPM)</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a configuration object for swerve modules.</div>
</div>
@@ -294,6 +301,13 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="angleMotorEncoderPulsePerRevolution">
<h3>angleMotorEncoderPulsePerRevolution</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">angleMotorEncoderPulsePerRevolution</span></div>
<div class="block">The integrated encoder pulse per revolution.</div>
</section>
</li>
<li>
<section class="detail" id="moduleLocation">
<h3>moduleLocation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Translation2d</span>&nbsp;<span class="element-name">moduleLocation</span></div>
@@ -337,7 +351,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)">
<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)">
<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,
@@ -351,7 +365,9 @@ loadScripts(document, 'script');</script>
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a>&nbsp;physicalCharacteristics,
boolean&nbsp;absoluteEncoderInverted,
boolean&nbsp;driveMotorInverted,
boolean&nbsp;angleMotorInverted)</span></div>
boolean&nbsp;angleMotorInverted,
double&nbsp;angleMotorEncoderPulsePerRevolution,
double&nbsp;angleMotorFreeSpeedRPM)</span></div>
<div class="block">Construct a configuration object for swerve modules.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -368,6 +384,8 @@ loadScripts(document, 'script');</script>
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
<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>