Prepare for release

Build
Team3128 · Feb 10, 2024 · 4ac51ca · 4ac51ca
1 parent 9b611d7
commit 4ac51ca
Show file tree

Hide file tree

Showing 19 changed files with 581 additions and 327 deletions.
diff --git a/3128-Common.json b/3128-Common.json
@@ -1,6 +1,6 @@
 {
   "name": "3128-common",
-  "version": "1.2.8",
+  "version": "1.3.0",
   "uuid": "ae3fa5a2-78d9-47e8-921a-dba45b889445",
   "frcYear": "2024",
   "mavenUrls": [
@@ -12,7 +12,7 @@
     {
       "groupId": "com.github.Team3128",
       "artifactId": "3128-common",
-      "version": "1.2.8"
+      "version": "1.3.0"
     }
   ],
   "jniDependencies": [],

diff --git a/3128-common.json b/3128-common.json
@@ -1,6 +1,6 @@
 {
   "name": "3128-common",
-  "version": "1.2.8",
+  "version": "1.3.0",
   "uuid": "ae3fa5a2-78d9-47e8-921a-dba45b889445",
   "frcYear": "2024",
   "mavenUrls": [
@@ -12,7 +12,7 @@
     {
       "groupId": "com.github.Team3128",
       "artifactId": "3128-common",
-      "version": "1.2.8"
+      "version": "1.3.0"
     }
   ],
   "jniDependencies": [],

diff --git a/doc/allclasses-index.html b/doc/allclasses-index.html
diff --git a/doc/common/core/swerve/SwerveModuleConfig.SwerveMotorConfig.html b/doc/common/core/swerve/SwerveModuleConfig.SwerveMotorConfig.html
@@ -89,11 +89,11 @@ <h2>Field Summary</h2>
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
-<div class="col-first even-row-color"><code>final <a href="../../hardware/motorcontroller/NAR_Motor.MotorConfig.html" title="class in common.hardware.motorcontroller">NAR_Motor.MotorConfig</a></code></div>
-<div class="col-second even-row-color"><code><a href="#motorConfig" class="member-name-link">motorConfig</a></code></div>
+<div class="col-first even-row-color"><code>final <a href="../../hardware/motorcontroller/NAR_CANSpark.html" title="class in common.hardware.motorcontroller">NAR_CANSpark</a></code></div>
+<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</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="#motorID" class="member-name-link">motorID</a></code></div>
+<div class="col-first odd-row-color"><code>final <a href="../../hardware/motorcontroller/NAR_Motor.MotorConfig.html" title="class in common.hardware.motorcontroller">NAR_Motor.MotorConfig</a></code></div>
+<div class="col-second odd-row-color"><code><a href="#motorConfig" class="member-name-link">motorConfig</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>final <a href="../controllers/PIDFFConfig.html" title="class in common.core.controllers">PIDFFConfig</a></code></div>
 <div class="col-second even-row-color"><code><a href="#pidffConfig" class="member-name-link">pidffConfig</a></code></div>
@@ -109,7 +109,7 @@ <h2>Constructor Summary</h2>
 <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(int,common.hardware.motorcontroller.NAR_Motor.MotorConfig,common.core.controllers.PIDFFConfig)" class="member-name-link">SwerveMotorConfig</a><wbr>(int&nbsp;motorID,
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(common.hardware.motorcontroller.NAR_CANSpark,common.hardware.motorcontroller.NAR_Motor.MotorConfig,common.core.controllers.PIDFFConfig)" class="member-name-link">SwerveMotorConfig</a><wbr>(<a href="../../hardware/motorcontroller/NAR_CANSpark.html" title="class in common.hardware.motorcontroller">NAR_CANSpark</a>&nbsp;motor,
  <a href="../../hardware/motorcontroller/NAR_Motor.MotorConfig.html" title="class in common.hardware.motorcontroller">NAR_Motor.MotorConfig</a>&nbsp;motorConfig,
  <a href="../controllers/PIDFFConfig.html" title="class in common.core.controllers">PIDFFConfig</a>&nbsp;pidffConfig)</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
@@ -135,9 +135,9 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="motorID">
-<h3>motorID</h3>
-<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">motorID</span></div>
+<section class="detail" id="motor">
+<h3>motor</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type"><a href="../../hardware/motorcontroller/NAR_CANSpark.html" title="class in common.hardware.motorcontroller">NAR_CANSpark</a></span>&nbsp;<span class="element-name">motor</span></div>
 </section>
 </li>
 <li>
@@ -161,9 +161,9 @@ <h3>pidffConfig</h3>
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="&lt;init&gt;(int,common.hardware.motorcontroller.NAR_Motor.MotorConfig,common.core.controllers.PIDFFConfig)">
+<section class="detail" id="&lt;init&gt;(common.hardware.motorcontroller.NAR_CANSpark,common.hardware.motorcontroller.NAR_Motor.MotorConfig,common.core.controllers.PIDFFConfig)">
 <h3>SwerveMotorConfig</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveMotorConfig</span><wbr><span class="parameters">(int&nbsp;motorID,
+<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SwerveMotorConfig</span><wbr><span class="parameters">(<a href="../../hardware/motorcontroller/NAR_CANSpark.html" title="class in common.hardware.motorcontroller">NAR_CANSpark</a>&nbsp;motor,
  <a href="../../hardware/motorcontroller/NAR_Motor.MotorConfig.html" title="class in common.hardware.motorcontroller">NAR_Motor.MotorConfig</a>&nbsp;motorConfig,
  <a href="../controllers/PIDFFConfig.html" title="class in common.core.controllers">PIDFFConfig</a>&nbsp;pidffConfig)</span></div>
 </section>

diff --git a/...ntroller/NAR_CANSparkMax.EncoderType.html → ...ntroller/NAR_CANSpark.ControllerType.html b/...ntroller/NAR_CANSparkMax.EncoderType.html → ...ntroller/NAR_CANSpark.ControllerType.html
@@ -2,10 +2,10 @@
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
-<title>NAR_CANSparkMax.EncoderType (3128-common)</title>
+<title>NAR_CANSpark.ControllerType (3128-common)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<meta name="description" content="declaration: package: common.hardware.motorcontroller, class: NAR_CANSparkMax, enum: EncoderType">
+<meta name="description" content="declaration: package: common.hardware.motorcontroller, class: NAR_CANSpark, enum: ControllerType">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
@@ -68,26 +68,26 @@
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">common.hardware.motorcontroller</a></div>
-<h1 title="Enum Class NAR_CANSparkMax.EncoderType" class="title">Enum Class NAR_CANSparkMax.EncoderType</h1>
+<h1 title="Enum Class NAR_CANSpark.ControllerType" class="title">Enum Class NAR_CANSpark.ControllerType</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
-<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a>&lt;<a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a>&gt;
-<div class="inheritance">common.hardware.motorcontroller.NAR_CANSparkMax.EncoderType</div>
+<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a>&lt;<a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a>&gt;
+<div class="inheritance">common.hardware.motorcontroller.NAR_CANSpark.ControllerType</div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
-<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
+<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>Enclosing class:</dt>
-<dd><a href="NAR_CANSparkMax.html" title="class in common.hardware.motorcontroller">NAR_CANSparkMax</a></dd>
+<dd><a href="NAR_CANSpark.html" title="class in common.hardware.motorcontroller">NAR_CANSpark</a></dd>
 </dl>
 <hr>
-<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">NAR_CANSparkMax.EncoderType</span>
-<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a>&gt;</span></div>
-<div class="block">Type of encoder used</div>
+<div class="type-signature"><span class="modifiers">public static enum </span><span class="element-name type-name-label">NAR_CANSpark.ControllerType</span>
+<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a>&gt;</span></div>
+<div class="block">Type of controller used</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
@@ -108,9 +108,9 @@ <h2>Enum Constant Summary</h2>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Enum Constant</div>
 <div class="table-header col-last">Description</div>
-<div class="col-first even-row-color"><code><a href="#Absolute" class="member-name-link">Absolute</a></code></div>
+<div class="col-first even-row-color"><code><a href="#CAN_SPARK_FLEX" class="member-name-link">CAN_SPARK_FLEX</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
-<div class="col-first odd-row-color"><code><a href="#Relative" class="member-name-link">Relative</a></code></div>
+<div class="col-first odd-row-color"><code><a href="#CAN_SPARK_MAX" class="member-name-link">CAN_SPARK_MAX</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
@@ -126,12 +126,12 @@ <h2>Method Summary</h2>
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
-<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a></code></div>
+<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<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 method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the enum constant of this class with the specified name.</div>
 </div>
-<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a>[]</code></div>
+<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a>[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns an array containing the constants of this enum class, in
@@ -158,15 +158,15 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
 <h2>Enum Constant Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="Relative">
-<h3>Relative</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a></span>&nbsp;<span class="element-name">Relative</span></div>
+<section class="detail" id="CAN_SPARK_MAX">
+<h3>CAN_SPARK_MAX</h3>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a></span>&nbsp;<span class="element-name">CAN_SPARK_MAX</span></div>
 </section>
 </li>
 <li>
-<section class="detail" id="Absolute">
-<h3>Absolute</h3>
-<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a></span>&nbsp;<span class="element-name">Absolute</span></div>
+<section class="detail" id="CAN_SPARK_FLEX">
+<h3>CAN_SPARK_FLEX</h3>
+<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a></span>&nbsp;<span class="element-name">CAN_SPARK_FLEX</span></div>
 </section>
 </li>
 </ul>
@@ -180,7 +180,7 @@ <h2>Method Details</h2>
 <li>
 <section class="detail" id="values()">
 <h3>values</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
 <div class="block">Returns an array containing the constants of this enum class, in
 the order they are declared.</div>
 <dl class="notes">
@@ -192,7 +192,7 @@ <h3>values</h3>
 <li>
 <section class="detail" id="valueOf(java.lang.String)">
 <h3>valueOf</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="NAR_CANSparkMax.EncoderType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSparkMax.EncoderType</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<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="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="NAR_CANSpark.ControllerType.html" title="enum class in common.hardware.motorcontroller">NAR_CANSpark.ControllerType</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<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">Returns the enum constant of this class with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this class.  (Extraneous whitespace characters are