Team2890/YAGSL
4
0
Fork 0
mirror of https://github.com/BroncBotz3481/YAGSL synced 2026-06-29 07:01:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated javadocs

Browse Source
This commit is contained in:
thenetworkgrinch
2023-08-09 16:23:30 -05:00
parent de4e35db62
commit 38c7bdba7d
156 changed files with 3972 additions and 33744 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/swervelib/telemetry/SwerveDriveTelemetry.html
View File

@@ -1,18 +1,17 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Sat Apr 08 13:46:47 CDT 2023 -->
<title>SwerveDriveTelemetry</title>
<!-- Generated by javadoc (17) -->
<title>SwerveDriveTelemetry (YAGSL-Lib API)</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-04-08">
<meta name="description" content="declaration: package: swervelib.telemetry, class: SwerveDriveTelemetry">
<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">
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
@@ -36,7 +35,7 @@ loadScripts(document, 'script');</script>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html#class">Help</a></li>
</ul>
</div>
@@ -78,7 +77,8 @@ loadScripts(document, 'script');</script>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveDriveTelemetry</span>
<span class="extends-implements">extends <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">Object</a></span></div>
<div class="block">Telemetry to describe the <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> following frc-web-components. (Which follows AdvantageKit)</div>
<div class="block">Telemetry to describe the <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> following frc-web-components. (Which
follows AdvantageKit)</div>
</section>
<section class="summary">
<ul class="summary-list">
@@ -313,24 +313,25 @@ loadScripts(document, 'script');</script>
<section class="detail" id="forwardDirection">
<h3>forwardDirection</h3>
<div class="member-signature"><span class="modifiers">public static</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">forwardDirection</span></div>
<div class="block">The direction the robot should be facing when the "Robot Rotation" is zero or blank. This option is often useful to
align with odometry data or match videos. 'up', 'right', 'down' or 'left'</div>
<div class="block">The direction the robot should be facing when the "Robot Rotation" is zero or blank. This
option is often useful to align with odometry data or match videos. 'up', 'right', 'down' or
'left'</div>
</section>
</li>
<li>
<section class="detail" id="maxAngularVelocity">
<h3>maxAngularVelocity</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">maxAngularVelocity</span></div>
<div class="block">The maximum achievable angular velocity of the robot. This is used to visualize the angular velocity from the
chassis speeds properties.</div>
<div class="block">The maximum achievable angular velocity of the robot. This is used to visualize the angular
velocity from the chassis speeds properties.</div>
</section>
</li>
<li>
<section class="detail" id="measuredChassisSpeeds">
<h3>measuredChassisSpeeds</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double[]</span>&nbsp;<span class="element-name">measuredChassisSpeeds</span></div>
<div class="block">The maximum achievable angular velocity of the robot. This is used to visualize the angular velocity from the
chassis speeds properties.</div>
<div class="block">The maximum achievable angular velocity of the robot. This is used to visualize the angular
velocity from the chassis speeds properties.</div>
</section>
</li>
<li>