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 Javadocs, added ability to push offset to absolute encoders.

Browse Source
This commit is contained in:
thenetworkgrinch
2023-12-12 10:48:54 -06:00
parent aef91407ea
commit f03926627d
123 changed files with 685 additions and 283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/swervelib/encoders/SparkMaxAnalogEncoderSwerve.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Dec 05 16:24:45 CST 2023 -->
<!-- Generated by javadoc (17) on Tue Dec 12 10:48:21 CST 2023 -->
<title>SparkMaxAnalogEncoderSwerve</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="2023-12-05">
<meta name="dc.created" content="2023-12-12">
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxAnalogEncoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -96,7 +96,7 @@ loadScripts(document, 'script');</script>
<div class="col-first even-row-color"><code>com.revrobotics.SparkMaxAnalogSensor</code></div>
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-last even-row-color">
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
<div class="block">The <code>SparkMaxAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
</div>
</div>
<div class="inherited-list">
@@ -114,7 +114,8 @@ loadScripts(document, 'script');</script>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor)" class="member-name-link">SparkMaxAnalogEncoderSwerve</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;motor)</code></div>
<div class="col-last even-row-color">
<div class="block">Create the <a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data port analog pin.</div>
<div class="block">Create the <a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data
port analog pin.</div>
</div>
</div>
</section>
@@ -165,6 +166,11 @@ loadScripts(document, 'script');</script>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the velocity in degrees/sec.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double&nbsp;offset)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
</div>
</div>
</div>
</div>
@@ -186,7 +192,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="encoder">
<h3>encoder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">com.revrobotics.SparkMaxAnalogSensor</span>&nbsp;<span class="element-name">encoder</span></div>
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
<div class="block">The <code>SparkMaxAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
</section>
</li>
</ul>
@@ -201,7 +207,8 @@ loadScripts(document, 'script');</script>
<section class="detail" id="&lt;init&gt;(swervelib.motors.SwerveMotor)">
<h3>SparkMaxAnalogEncoderSwerve</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SparkMaxAnalogEncoderSwerve</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a>&nbsp;motor)</span></div>
<div class="block">Create the <a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data port analog pin.</div>
<div class="block">Create the <a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data
port analog pin.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>motor</code> - Motor to create the encoder from.</dd>
@@ -289,6 +296,21 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="setAbsoluteEncoderOffset(double)">
<h3>setAbsoluteEncoderOffset</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double&nbsp;offset)</span></div>
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code>&nbsp;in class&nbsp;<code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
<dt>Parameters:</dt>
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
<dt>Returns:</dt>
<dd>if setting Absolute Encoder Offset was successful or not.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getVelocity()">
<h3>getVelocity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getVelocity</span>()</div>