Prepare for release

Team3128 · Feb 14, 2024 · 17ea5ed · 17ea5ed
1 parent 5b95682
commit 17ea5ed
Show file tree

Hide file tree

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

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

diff --git a/doc/allclasses-index.html b/doc/allclasses-index.html
diff --git a/doc/common/core/swerve/SwerveModule.html b/doc/common/core/swerve/SwerveModule.html
@@ -148,7 +148,9 @@ <h2>Method Summary</h2>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../utility/narwhaldashboard/NarwhalDashboard.State.html" title="enum class in common.utility.narwhaldashboard">NarwhalDashboard.State</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRunningState()" class="member-name-link">getRunningState</a>()</code></div>
-<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
+<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
+<div class="block">Return the state of the swerve module.</div>
+</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
@@ -331,6 +333,11 @@ <h3>getAngleMotor</h3>
 <section class="detail" id="getRunningState()">
 <h3>getRunningState</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../../utility/narwhaldashboard/NarwhalDashboard.State.html" title="enum class in common.utility.narwhaldashboard">NarwhalDashboard.State</a></span>&nbsp;<span class="element-name">getRunningState</span>()</div>
+<div class="block">Return the state of the swerve module.</div>
+<dl class="notes">
+<dt>Returns:</dt>
+<dd>State of the swerve module.</dd>
+</dl>
 </section>
 </li>
 </ul>

diff --git a/doc/common/hardware/camera/Camera.html b/doc/common/hardware/camera/Camera.html
@@ -90,17 +90,29 @@ <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 edu.wpi.first.apriltag.AprilTagFields</code></div>
+<div class="col-second even-row-color"><code><a href="#aprilTags" class="member-name-link">aprilTags</a></code></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-row-color"><code>final org.photonvision.PhotonPoseEstimator.PoseStrategy</code></div>
+<div class="col-second odd-row-color"><code><a href="#calc_strategy" class="member-name-link">calc_strategy</a></code></div>
+<div class="col-last odd-row-color">&nbsp;</div>
+<div class="col-first even-row-color"><code>final org.photonvision.PhotonPoseEstimator</code></div>
+<div class="col-second even-row-color"><code><a href="#estimator" class="member-name-link">estimator</a></code></div>
+<div class="col-last even-row-color">&nbsp;</div>
+<div class="col-first odd-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 odd-row-color"><code><a href="#name" class="member-name-link">name</a></code></div>
+<div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>final double</code></div>
-<div class="col-second even-row-color"><code><a href="#cameraPitch" class="member-name-link">cameraPitch</a></code></div>
+<div class="col-second even-row-color"><code><a href="#pitchOffset" class="member-name-link">pitchOffset</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
-<div class="col-first odd-row-color"><code>boolean</code></div>
-<div class="col-second odd-row-color"><code><a href="#enabled" class="member-name-link">enabled</a></code></div>
+<div class="col-first odd-row-color"><code>final double</code></div>
+<div class="col-second odd-row-color"><code><a href="#xOffset" class="member-name-link">xOffset</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</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="#name" class="member-name-link">name</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="#yawOffset" class="member-name-link">yawOffset</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
-<div class="col-first odd-row-color"><code>final edu.wpi.first.math.geometry.Transform2d</code></div>
-<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
+<div class="col-first odd-row-color"><code>final double</code></div>
+<div class="col-second odd-row-color"><code><a href="#yOffset" class="member-name-link">yOffset</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 </div>
 </section>
@@ -113,13 +125,14 @@ <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(java.lang.String,boolean,edu.wpi.first.math.geometry.Transform2d,double)" class="member-name-link">Camera</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,
- boolean&nbsp;enabled,
- edu.wpi.first.math.geometry.Transform2d&nbsp;cameraOffset,
- double&nbsp;cameraPitch)</code></div>
-<div class="col-last even-row-color">
-<div class="block">Creates a new object for a camera.</div>
-</div>
+<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,double,double,double,double,edu.wpi.first.apriltag.AprilTagFields,org.photonvision.PhotonPoseEstimator.PoseStrategy)" class="member-name-link">Camera</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,
+ double&nbsp;xOffset,
+ double&nbsp;yOffset,
+ double&nbsp;pitchOffset,
+ double&nbsp;yawOffset,
+ edu.wpi.first.apriltag.AprilTagFields&nbsp;aprilTags,
+ org.photonvision.PhotonPoseEstimator.PoseStrategy&nbsp;calc_strategy)</code></div>
+<div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
@@ -148,21 +161,45 @@ <h3>name</h3>
 </section>
 </li>
 <li>
-<section class="detail" id="offset">
-<h3>offset</h3>
-<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">edu.wpi.first.math.geometry.Transform2d</span>&nbsp;<span class="element-name">offset</span></div>
+<section class="detail" id="xOffset">
+<h3>xOffset</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">xOffset</span></div>
 </section>
 </li>
 <li>
-<section class="detail" id="enabled">
-<h3>enabled</h3>
-<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">enabled</span></div>
+<section class="detail" id="yOffset">
+<h3>yOffset</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">yOffset</span></div>
 </section>
 </li>
 <li>
-<section class="detail" id="cameraPitch">
-<h3>cameraPitch</h3>
-<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">cameraPitch</span></div>
+<section class="detail" id="pitchOffset">
+<h3>pitchOffset</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">pitchOffset</span></div>
+</section>
+</li>
+<li>
+<section class="detail" id="yawOffset">
+<h3>yawOffset</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">yawOffset</span></div>
+</section>
+</li>
+<li>
+<section class="detail" id="aprilTags">
+<h3>aprilTags</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">edu.wpi.first.apriltag.AprilTagFields</span>&nbsp;<span class="element-name">aprilTags</span></div>
+</section>
+</li>
+<li>
+<section class="detail" id="calc_strategy">
+<h3>calc_strategy</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">org.photonvision.PhotonPoseEstimator.PoseStrategy</span>&nbsp;<span class="element-name">calc_strategy</span></div>
+</section>
+</li>
+<li>
+<section class="detail" id="estimator">
+<h3>estimator</h3>
+<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">org.photonvision.PhotonPoseEstimator</span>&nbsp;<span class="element-name">estimator</span></div>
 </section>
 </li>
 </ul>
@@ -174,19 +211,15 @@ <h3>cameraPitch</h3>
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
-<section class="detail" id="&lt;init&gt;(java.lang.String,boolean,edu.wpi.first.math.geometry.Transform2d,double)">
+<section class="detail" id="&lt;init&gt;(java.lang.String,double,double,double,double,edu.wpi.first.apriltag.AprilTagFields,org.photonvision.PhotonPoseEstimator.PoseStrategy)">
 <h3>Camera</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Camera</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,
- boolean&nbsp;enabled,
- edu.wpi.first.math.geometry.Transform2d&nbsp;cameraOffset,
- double&nbsp;cameraPitch)</span></div>
-<div class="block">Creates a new object for a camera.</div>
-<dl class="notes">
-<dt>Parameters:</dt>
-<dd><code>name</code> - Name of camera on photonvision.</dd>
-<dd><code>enabled</code> - Whether or not to return results.</dd>
-<dd><code>cameraOffset</code> - Offset from robot as a transform2d.</dd>
-</dl>
+ double&nbsp;xOffset,
+ double&nbsp;yOffset,
+ double&nbsp;pitchOffset,
+ double&nbsp;yawOffset,
+ edu.wpi.first.apriltag.AprilTagFields&nbsp;aprilTags,
+ org.photonvision.PhotonPoseEstimator.PoseStrategy&nbsp;calc_strategy)</span></div>
 </section>
 </li>
 </ul>