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

Updated javadocs

Browse Source
This commit is contained in:
thenetworkgrinch
2023-11-09 18:54:46 -06:00
parent 6aaf512b38
commit a0d8d440e3
109 changed files with 1004 additions and 1032 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/swervelib/SwerveController.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Fri Sep 01 00:20:10 CDT 2023 -->
<!-- Generated by javadoc (17) on Thu Nov 09 18:54:29 CST 2023 -->
<title>SwerveController</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-09-01">
<meta name="dc.created" content="2023-11-09">
<meta name="description" content="declaration: package: swervelib, class: SwerveController">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
@@ -181,19 +181,21 @@ loadScripts(document, 'script');</script>
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double&nbsp;xInput,
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double&nbsp;xInput,
double&nbsp;yInput,
double&nbsp;angle,
double&nbsp;currentHeadingAngleRadians)</code></div>
double&nbsp;currentHeadingAngleRadians,
double&nbsp;maxSpeed)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</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.ChassisSpeeds</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double&nbsp;xInput,
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double&nbsp;xInput,
double&nbsp;yInput,
double&nbsp;headingX,
double&nbsp;headingY,
double&nbsp;currentHeadingAngleRadians)</code></div>
double&nbsp;currentHeadingAngleRadians,
double&nbsp;maxSpeed)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
</div>
@@ -353,19 +355,22 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="getTargetSpeeds(double,double,double,double)">
<section class="detail" id="getTargetSpeeds(double,double,double,double,double)">
<h3>getTargetSpeeds</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span>&nbsp;<span class="element-name">getTargetSpeeds</span><wbr><span class="parameters">(double&nbsp;xInput,
double&nbsp;yInput,
double&nbsp;angle,
double&nbsp;currentHeadingAngleRadians)</span></div>
double&nbsp;currentHeadingAngleRadians,
double&nbsp;maxSpeed)</span></div>
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction.</dd>
<dd><code>yInput</code> - Y joystick input for the robot to move in the Y direction.</dd>
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction. X = xInput * maxSpeed</dd>
<dd><code>yInput</code> - Y joystick input for the robot to move in the Y direction. Y = yInput *
maxSpeed;</dd>
<dd><code>angle</code> - The desired angle of the robot in radians.</dd>
<dd><code>currentHeadingAngleRadians</code> - The current robot heading in radians.</dd>
<dd><code>maxSpeed</code> - Maximum speed in meters per second.</dd>
<dt>Returns:</dt>
<dd><code>ChassisSpeeds</code> which can be sent to th Swerve Drive.</dd>
</dl>
@@ -387,13 +392,14 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="getTargetSpeeds(double,double,double,double,double)">
<section class="detail" id="getTargetSpeeds(double,double,double,double,double,double)">
<h3>getTargetSpeeds</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span>&nbsp;<span class="element-name">getTargetSpeeds</span><wbr><span class="parameters">(double&nbsp;xInput,
double&nbsp;yInput,
double&nbsp;headingX,
double&nbsp;headingY,
double&nbsp;currentHeadingAngleRadians)</span></div>
double&nbsp;currentHeadingAngleRadians,
double&nbsp;maxSpeed)</span></div>
<div class="block">Get the chassis speeds based on controller input of 2 joysticks. One for speeds in which direction. The other for
the angle of the robot.</div>
<dl class="notes">
@@ -403,6 +409,8 @@ loadScripts(document, 'script');</script>
<dd><code>headingX</code> - X joystick which controls the angle of the robot.</dd>
<dd><code>headingY</code> - Y joystick which controls the angle of the robot.</dd>
<dd><code>currentHeadingAngleRadians</code> - The current robot heading in radians.</dd>
<dd><code>maxSpeed</code> - Maximum speed of the drive motors in meters per second, multiplier of the xInput
and yInput.</dd>
<dt>Returns:</dt>
<dd><code>ChassisSpeeds</code> which can be sent to th Swerve Drive.</dd>
</dl>