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 docs

Browse Source
This commit is contained in:
thenetworkgrinch
2024-01-17 09:18:38 -06:00
parent 1ca3db242c
commit 889c85172f
108 changed files with 1609 additions and 370 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/swervelib/encoders/CANCoderSwerve.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Tue Jan 16 16:53:42 CST 2024 -->
<!-- Generated by javadoc (17) on Wed Jan 17 09:18:05 CST 2024 -->
<title>CANCoderSwerve</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-16">
<meta name="dc.created" content="2024-01-17">
<meta name="description" content="declaration: package: swervelib.encoders, class: CANCoderSwerve">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
@@ -93,11 +93,31 @@ loadScripts(document, 'script');</script>
<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>com.ctre.phoenix6.hardware.CANcoder</code></div>
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#cannotSetOffset" class="member-name-link">cannotSetOffset</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</div>
<div class="col-first odd-row-color"><code>com.ctre.phoenix6.hardware.CANcoder</code></div>
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
<div class="col-last odd-row-color">
<div class="block">CANCoder with WPILib sendable and support.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#magnetFieldLessThanIdeal" class="member-name-link">magnetFieldLessThanIdeal</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</div>
</div>
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second odd-row-color"><code><a href="#readingFaulty" class="member-name-link">readingFaulty</a></code></div>
<div class="col-last odd-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
</div>
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
<div class="col-second even-row-color"><code><a href="#readingIgnored" class="member-name-link">readingIgnored</a></code></div>
<div class="col-last even-row-color">
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</div>
</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class&nbsp;swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
@@ -194,6 +214,34 @@ loadScripts(document, 'script');</script>
<div class="block">CANCoder with WPILib sendable and support.</div>
</section>
</li>
<li>
<section class="detail" id="magnetFieldLessThanIdeal">
<h3>magnetFieldLessThanIdeal</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">magnetFieldLessThanIdeal</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</div>
</section>
</li>
<li>
<section class="detail" id="readingFaulty">
<h3>readingFaulty</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">readingFaulty</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
</section>
</li>
<li>
<section class="detail" id="readingIgnored">
<h3>readingIgnored</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">readingIgnored</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</div>
</section>
</li>
<li>
<section class="detail" id="cannotSetOffset">
<h3>cannotSetOffset</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span>&nbsp;<span class="element-name">cannotSetOffset</span></div>
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
</section>
</li>
</ul>
</section>
</li>