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.6.3

Browse Source
This commit is contained in:
thenetworkgrinch
2024-01-26 11:29:15 -06:00
parent bd949c2fa5
commit 75ec1aee24
121 changed files with 1751 additions and 552 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 23 20:51:53 CST 2024 -->
<!-- Generated by javadoc (17) on Fri Jan 26 11:27:20 CST 2024 -->
<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="2024-01-23">
<meta name="dc.created" content="2024-01-26">
<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">
@@ -147,9 +147,14 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-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-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><code><a href="#useCosineCompensator" class="member-name-link">useCosineCompensator</a></code></div>
<div class="col-last even-row-color">
<div class="block">Should do cosine compensation when not pointing correct direction;.</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="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
</div>
</div>
@@ -163,7 +168,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.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String)" 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.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String,boolean)" 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="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a>&nbsp;conversionFactors,
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;absoluteEncoder,
@@ -176,11 +181,12 @@ loadScripts(document, 'script');</script>
boolean&nbsp;absoluteEncoderInverted,
boolean&nbsp;driveMotorInverted,
boolean&nbsp;angleMotorInverted,
<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>
<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,
boolean&nbsp;useCosineCompensator)</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.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,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,
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String,boolean)" 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="json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a>&nbsp;conversionFactors,
<a href="../encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>&nbsp;absoluteEncoder,
@@ -190,7 +196,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,
<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>
<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,
boolean&nbsp;useCosineCompensator)</code></div>
<div class="col-last odd-row-color">
<div class="block">Construct a configuration object for swerve modules.</div>
</div>
@@ -309,6 +316,13 @@ loadScripts(document, 'script');</script>
<div class="block">Name for the swerve module for telemetry.</div>
</section>
</li>
<li>
<section class="detail" id="useCosineCompensator">
<h3>useCosineCompensator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">useCosineCompensator</span></div>
<div class="block">Should do cosine compensation when not pointing correct direction;.</div>
</section>
</li>
</ul>
</section>
</li>
@@ -318,7 +332,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.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String)">
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String,boolean)">
<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,
@@ -333,7 +347,8 @@ loadScripts(document, 'script');</script>
boolean&nbsp;absoluteEncoderInverted,
boolean&nbsp;driveMotorInverted,
boolean&nbsp;angleMotorInverted,
<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>
<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,
boolean&nbsp;useCosineCompensator)</span></div>
<div class="block">Construct a configuration object for swerve modules.</div>
<dl class="notes">
<dt>Parameters:</dt>
@@ -351,11 +366,12 @@ loadScripts(document, 'script');</script>
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
<dd><code>name</code> - The name for the swerve module.</dd>
<dd><code>conversionFactors</code> - Conversion factors to be applied to the drive and angle motors.</dd>
<dd><code>useCosineCompensator</code> - Should use cosineCompensation.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)">
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String,boolean)">
<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 +383,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,
<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>
<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,
boolean&nbsp;useCosineCompensator)</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">
@@ -383,6 +400,7 @@ loadScripts(document, 'script');</script>
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
<dd><code>name</code> - Name for the module.</dd>
<dd><code>useCosineCompensator</code> - Should use cosineCompensation.</dd>
</dl>
</section>
</li>