Skip to content

Commit

Permalink
added canbus utility to swerve cancoders
Browse files Browse the repository at this point in the history
ready for release
  • Loading branch information
Wi11iamYuan committed Sep 20, 2024
1 parent b398bb6 commit c4301ba
Show file tree
Hide file tree
Showing 19 changed files with 138 additions and 294 deletions.
4 changes: 2 additions & 2 deletions 3128-Common.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "3128-common",
"version": "1.8.0",
"version": "1.8.1",
"uuid": "ae3fa5a2-78d9-47e8-921a-dba45b889445",
"frcYear": "2024",
"mavenUrls": [
Expand All @@ -12,7 +12,7 @@
{
"groupId": "com.github.Team3128",
"artifactId": "3128-common",
"version": "1.8.0"
"version": "1.8.1"
}
],
"jniDependencies": [],
Expand Down
4 changes: 2 additions & 2 deletions 3128-common.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "3128-common",
"version": "1.8.0",
"version": "1.8.1",
"uuid": "ae3fa5a2-78d9-47e8-921a-dba45b889445",
"frcYear": "2024",
"mavenUrls": [
Expand All @@ -12,7 +12,7 @@
{
"groupId": "com.github.Team3128",
"artifactId": "3128-common",
"version": "1.8.0"
"version": "1.8.1"
}
],
"jniDependencies": [],
Expand Down
26 changes: 12 additions & 14 deletions doc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -252,28 +252,26 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/core/swerve/SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/core/swerve/SwerveModuleConstants.html" title="class in common.core.swerve">SwerveModuleConstants</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.html" title="class in common.utility.tester">Tester</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.html" title="class in common.utility.tester">Tester</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Team 3128's Tester utility class used to run system checks at competitions.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.SystemsTest.html" title="class in common.utility.tester">Tester.SystemsTest</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.SystemsTest.html" title="class in common.utility.tester">Tester.SystemsTest</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">System test</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.Test.html" title="class in common.utility.tester">Tester.Test</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/Tester.Test.html" title="class in common.utility.tester">Tester.Test</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Collection of tests to be run for a system</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="common/utility/tester/Tester.TestState.html" title="enum class in common.utility.tester">Tester.TestState</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="common/utility/tester/Tester.TestState.html" title="enum class in common.utility.tester">Tester.TestState</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
<div class="block">Enum representing test states</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/ThresholdTest.html" title="class in common.utility.tester">ThresholdTest</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/core/controllers/TrapController.html" title="class in common.core.controllers">TrapController</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="common/utility/tester/ThresholdTest.html" title="class in common.utility.tester">ThresholdTest</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="common/core/controllers/TrapController.html" title="class in common.core.controllers">TrapController</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Team 3128's streamlined <code>ProfiledPIDController</code> class.</div>
</div>
</div>
Expand Down
51 changes: 41 additions & 10 deletions doc/common/core/swerve/SwerveModuleConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,21 +107,24 @@ <h2>Field Summary</h2>
<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">&nbsp;</div>
<div class="col-first even-row-color"><code>final int</code></div>
<div class="col-second even-row-color"><code><a href="#cancoderID" class="member-name-link">cancoderID</a></code></div>
<div class="col-first even-row-color"><code>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="#canbusString" class="member-name-link">canbusString</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#CANCoderinvert" class="member-name-link">CANCoderinvert</a></code></div>
<div class="col-first odd-row-color"><code>final int</code></div>
<div class="col-second odd-row-color"><code><a href="#cancoderID" class="member-name-link">cancoderID</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>final <a href="SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a></code></div>
<div class="col-second even-row-color"><code><a href="#driveConfig" class="member-name-link">driveConfig</a></code></div>
<div class="col-first even-row-color"><code>final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#CANCoderinvert" class="member-name-link">CANCoderinvert</a></code></div>
<div class="col-last even-row-color">&nbsp;</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-first odd-row-color"><code>final <a href="SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a></code></div>
<div class="col-second odd-row-color"><code><a href="#driveConfig" class="member-name-link">driveConfig</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>final 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-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">&nbsp;</div>
<div class="col-first odd-row-color"><code>final 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">&nbsp;</div>
</div>
</section>
</li>
Expand All @@ -141,6 +144,15 @@ <h2>Constructor Summary</h2>
boolean&nbsp;CANCoderinvert,
double&nbsp;maxSpeed)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,common.core.swerve.SwerveModuleConfig.SwerveMotorConfig,common.core.swerve.SwerveModuleConfig.SwerveMotorConfig,int,java.lang.String,double,boolean,double)" class="member-name-link">SwerveModuleConfig</a><wbr>(int&nbsp;moduleNumber,
<a href="SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a>&nbsp;driveConfig,
<a href="SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a>&nbsp;angleConfig,
int&nbsp;canCoderID,
<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;canbusString,
double&nbsp;angleOffset,
boolean&nbsp;CANCoderinvert,
double&nbsp;maxSpeed)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
Expand Down Expand Up @@ -187,6 +199,12 @@ <h3>cancoderID</h3>
</section>
</li>
<li>
<section class="detail" id="canbusString">
<h3>canbusString</h3>
<div class="member-signature"><span class="modifiers">public 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">canbusString</span></div>
</section>
</li>
<li>
<section class="detail" id="angleOffset">
<h3>angleOffset</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">angleOffset</span></div>
Expand All @@ -213,6 +231,19 @@ <h3>maxSpeed</h3>
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(int,common.core.swerve.SwerveModuleConfig.SwerveMotorConfig,common.core.swerve.SwerveModuleConfig.SwerveMotorConfig,int,java.lang.String,double,boolean,double)">
<h3>SwerveModuleConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveModuleConfig</span><wbr><span class="parameters">(int&nbsp;moduleNumber,
<a href="SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a>&nbsp;driveConfig,
<a href="SwerveModuleConfig.SwerveMotorConfig.html" title="class in common.core.swerve">SwerveModuleConfig.SwerveMotorConfig</a>&nbsp;angleConfig,
int&nbsp;canCoderID,
<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;canbusString,
double&nbsp;angleOffset,
boolean&nbsp;CANCoderinvert,
double&nbsp;maxSpeed)</span></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int,common.core.swerve.SwerveModuleConfig.SwerveMotorConfig,common.core.swerve.SwerveModuleConfig.SwerveMotorConfig,int,double,boolean,double)">
<h3>SwerveModuleConfig</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveModuleConfig</span><wbr><span class="parameters">(int&nbsp;moduleNumber,
Expand Down
Loading

0 comments on commit c4301ba

Please sign in to comment.