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
Files
fab24d2fd1e0cfb3cd73fc1787c8bf50d8039e1e
YAGSL/docs/index-files/index-17.html

553 lines
56 KiB
HTML
Raw Normal View History

First commit
2023-01-29 21:03:26 -06:00
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<!-- Generated by javadoc (11.0.13) on Tue Jan 31 10:51:37 CST 2023 -->
First commit
2023-01-29 21:03:26 -06:00
<title>S-Index</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<meta name="dc.created" content="2023-01-31">
First commit
2023-01-29 21:03:26 -06:00
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../script.js"></script>
<script type="text/javascript" src="../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="S-Index";
}
}
catch(err) {
}
//-->
var pathtoroot = "../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<li>Use</li>
First commit
2023-01-29 21:03:26 -06:00
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<main role="main">
<div class="contentContainer"><a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a><a id="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#saveConfig()">saveConfig()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Save configuration data to the motor controller so it is persistent on reboot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#saveConfig()">saveConfig()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Save configuration data to the motor controller so it is persistent on reboot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#saveConfig()">saveConfig()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Save configuration data to the motor controller so it is persistent on reboot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#set(double)">set(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the speed of the drive motor from -1 to 1.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#set(double)">set(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the speed of the drive motor from -1 to 1.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#set(double)">set(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Common interface for setting the speed of a motor controller.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#set(double)">set(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the speed of the drive motor from -1 to 1.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#set(double,double,double,boolean)">set(double, double, double, boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Swerve drive function</div>
</dd>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#set(edu.wpi.first.math.kinematics.ChassisSpeeds)">set(ChassisSpeeds)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Set the swerve drive module states.</div>
</dd>
First commit
2023-01-29 21:03:26 -06:00
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setAngle(double)">setAngle(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the angle of the swerve module without feedforward.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setAngle(double,double)">setAngle(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the angle of the swerve module.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setAngleOffset(double)">setAngleOffset(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Configure the magnetic offset in the CANCoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setCANStatusFrames(int,int,int,int,int)">setCANStatusFrames(int, int, int, int, int)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the CAN status frames.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setConversionFactor(double)">setConversionFactor(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Configures the conversion factor based upon which motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setConversionFactor(double)">setConversionFactor(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Configures the conversion factor based upon which motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setConversionFactor(double)">setConversionFactor(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Configures the conversion factor based upon which motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setCurrentLimit(int)">setCurrentLimit(int)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setCurrentLimit(int)">setCurrentLimit(int)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setCurrentLimit(int)">setCurrentLimit(int)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setCurrentLimit(int,frc.robot.subsystems.swervedrive.swerve.SwerveMotor.ModuleMotorType)">setCurrentLimit(int, SwerveMotor.ModuleMotorType)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
voltage compensation.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setEncoder(double)">setEncoder(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the encoder value.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setEncoder(double)">setEncoder(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the encoder value.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setEncoder(double)">setEncoder(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the encoder value.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#setGyroInverted(boolean)">setGyroInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Invert the gyroscope reading.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">CTRECANCoder</a></dt>
<dd>
<div class="block">Configure the sensor direction</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMAnalogEncoder</a></dt>
<dd>
<div class="block">Configure the sensor direction</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMDutyCycleEncoder</a></dt>
<dd>
<div class="block">Configure the sensor direction</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">REVAbsoluteEncoder</a></dt>
<dd>
<div class="block">Configure the sensor direction.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Invert the motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Invert the motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a></dt>
<dd>
<div class="block">Configure the sensor direction</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Common interface for inverting direction of a motor controller.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setInverted(boolean)">setInverted(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Invert the motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setInvertedAbsoluteEncoder(boolean)">setInvertedAbsoluteEncoder(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Invert the absolute encoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setInvertedTurn(boolean)">setInvertedTurn(boolean)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the steering motor to be inverted.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#setModulePIDF(frc.robot.subsystems.swervedrive.swerve.SwerveMotor,com.fasterxml.jackson.databind.JsonNode)">setModulePIDF(SwerveMotor, JsonNode)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>
<div class="block">Set the PIDF for the module if the given JSON has the paramters.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#setModuleStates(frc.robot.subsystems.swervedrive.swerve.kinematics.SwerveModuleState2%5B%5D)">setModuleStates(SwerveModuleState2[])</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Set the swerve module states given an array of states.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html#setOffset(double)">setOffset(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/CTRECANCoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">CTRECANCoder</a></dt>
<dd>
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html#setOffset(double)">setOffset(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMAnalogEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMAnalogEncoder</a></dt>
<dd>
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html#setOffset(double)">setOffset(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/PWMDutyCycleEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">PWMDutyCycleEncoder</a></dt>
<dd>
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html#setOffset(double)">setOffset(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.encoders.<a href="../frc/robot/subsystems/swervedrive/swerve/encoders/REVAbsoluteEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve.encoders">REVAbsoluteEncoder</a></dt>
<dd>
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html#setOffset(double)">setOffset(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a></dt>
<dd>
<div class="block">Configure the magnetic offset for the AbsoluteEncoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setPIDF(double,double,double,double,double)">setPIDF(double, double, double, double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the PIDF coefficients for the closed loop PID onboard the SparkMax.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setPIDF(double,double,double,double,double)">setPIDF(double, double, double, double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the PIDF coefficients for the closed loop PID onboard the SparkMax.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setPIDF(double,double,double,double,double)">setPIDF(double, double, double, double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the PIDF coefficients for the closed loop PID onboard the SparkMax.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#setPIDF(double,double,double,double,double,frc.robot.subsystems.swervedrive.swerve.SwerveMotor.ModuleMotorType)">setPIDF(double, double, double, double, double, SwerveMotor.ModuleMotorType)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Set the PIDF coefficients for the closed loop PID onboard the motor controller.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setPIDF(double,double,double,double,double,frc.robot.subsystems.swervedrive.swerve.SwerveMotor.ModuleMotorType)">setPIDF(double, double, double, double, double, SwerveMotor.ModuleMotorType)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the PIDF coefficients for the closed loop PID onboard the motor controller.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setPIDOutputRange(double,double)">setPIDOutputRange(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Configure the maximum power (-1 to 1) the PID can output.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setPIDOutputRange(double,double)">setPIDOutputRange(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Configure the maximum power (-1 to 1) the PID can output.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setPIDOutputRange(double,double)">setPIDOutputRange(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Configure the maximum power (-1 to 1) the PID can output.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setState(frc.robot.subsystems.swervedrive.swerve.kinematics.SwerveModuleState2)">setState(SwerveModuleState2)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the module speed and angle based off the module state.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setTarget(double,double)">setTarget(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the target for the PID loop.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setTarget(double,double)">setTarget(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the target for the PID loop.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setTarget(double,double)">setTarget(double, double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the target for the PID loop.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.Verbosity.html#SETUP">SETUP</a></span> - frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.Verbosity.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.Verbosity</a></dt>
<dd>
<div class="block">Creates every field for the module.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setVelocity(double)">setVelocity(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the drive motor velocity in MPS.</div>
</dd>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setVoltage(double)">setVoltage(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage of the motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setVoltage(double)">setVoltage(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage of the motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setVoltage(double)">setVoltage(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage of the motor.</div>
</dd>
First commit
2023-01-29 21:03:26 -06:00
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#setVoltageCompensation()">setVoltageCompensation()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Enable voltage compensation to the current battery voltage on all modules.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#setVoltageCompensation(double)">setVoltageCompensation(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#setVoltageCompensation(double)">setVoltageCompensation(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#setVoltageCompensation(double)">setVoltageCompensation(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#setVoltageCompensation(double)">setVoltageCompensation(double)</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#setX()">setX()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Sets the wheels into an X formation to prevent movement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.REV_slotIdx.html#Simulation">Simulation</a></span> - frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.REV_slotIdx.html" title="enum in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor.REV_slotIdx</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html#steering">steering</a></span> - Variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive.SwerveModuleConfig</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#steeringKV">steeringKV</a></span> - Variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">kV for steering feedforward.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html#stop()">stop()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/CTRESwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">CTRESwerveMotor</a></dt>
<dd>
<div class="block">Stop the motor by sending 0 volts to it.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html#stop()">stop()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.motors.<a href="../frc/robot/subsystems/swervedrive/swerve/motors/REVSwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve.motors">REVSwerveMotor</a></dt>
<dd>
<div class="block">Stop the motor by sending 0 volts to it.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#stop()">stop()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>
<div class="block">Stop the motor by sending 0 volts to it.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#stopMotor()">stopMotor()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Stop all running and turning motors.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#stopMotor()">stopMotor()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Stops motor movement.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#subscribe()">subscribe()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Update swerve module parameters based on data in the dashboard.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#subscribe()">subscribe()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Subscribe from data within smart dashboard to make changes to the swerve module.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveDrive</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">SwerveDrive base which is meant to be platform agnostic.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#%3Cinit%3E(frc.robot.subsystems.swervedrive.swerve.SwerveModule,frc.robot.subsystems.swervedrive.swerve.SwerveModule,frc.robot.subsystems.swervedrive.swerve.SwerveModule,frc.robot.subsystems.swervedrive.swerve.SwerveModule,com.ctre.phoenix.sensors.WPI_Pigeon2,double,double,double,double,double,boolean,edu.wpi.first.math.geometry.Pose2d)">SwerveDrive(SwerveModule&lt;?, ?, ?&gt;, SwerveModule&lt;?, ?, ?&gt;, SwerveModule&lt;?, ?, ?&gt;, SwerveModule&lt;?, ?, ?&gt;, WPI_Pigeon2, double, double, double, double, double, boolean, Pose2d)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Constructor for Swerve Drive assuming modules have been created and configured with PIDF and conversions.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="class in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveDrive.SwerveModuleConfig</span></a>&lt;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">DriveMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,&#8203;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">SteeringMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,&#8203;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="type parameter in SwerveDrive.SwerveModuleConfig">AbsoluteEncoder</a> extends com.ctre.phoenix.sensors.CANCoder&gt; - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Helper class for easier swerve module creation</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveDriveKinematics2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics"><span class="typeNameLink">SwerveDriveKinematics2</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/package-summary.html">frc.robot.subsystems.swervedrive.swerve.kinematics</a></dt>
<dd>
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
speed.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveDriveKinematics2.html#%3Cinit%3E(edu.wpi.first.math.geometry.Translation2d...)">SwerveDriveKinematics2(Translation2d...)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.kinematics.<a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveDriveKinematics2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveDriveKinematics2</a></dt>
<dd>
<div class="block">Constructs a swerve drive kinematics object.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveEncoder</span></a>&lt;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="type parameter in SwerveEncoder">AbsoluteEncoderType</a>&gt; - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Swerve Encoder class definition for common interfaces.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html#%3Cinit%3E()">SwerveEncoder()</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveEncoder.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveEncoder</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#swerveLocation">swerveLocation</a></span> - Variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Enum representing the swerve module's location on the robot, assuming square.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveModule</span></a>&lt;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="type parameter in SwerveModule">DriveMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,&#8203;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="type parameter in SwerveModule">AngleMotorType</a> extends edu.wpi.first.wpilibj.motorcontrol.MotorController,&#8203;<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="type parameter in SwerveModule">AbsoluteEncoderType</a>&gt; - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Swerve module for representing a single swerve module of the robot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#%3Cinit%3E(DriveMotorType,AngleMotorType,AbsoluteEncoderType,frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation,double,double,double,double,double,double,double,double,double,double,double,boolean,boolean)">SwerveModule(DriveMotorType, AngleMotorType, AbsoluteEncoderType, SwerveModule.SwerveModuleLocation, double, double, double, double, double, double, double, double, double, double, double, boolean, boolean)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Swerve module constructor.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveModule.SwerveModuleLocation</span></a> - Enum in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Swerve Module location on the robot.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.Verbosity.html" title="enum in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveModule.Verbosity</span></a> - Enum in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Verbosity levels for data publishing,</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html#%3Cinit%3E(DriveMotorType,SteeringMotorType,AbsoluteEncoder,double,frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">SwerveModuleConfig(DriveMotorType, SteeringMotorType, AbsoluteEncoder, double, SwerveModule.SwerveModuleLocation)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.SwerveModuleConfig.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive.SwerveModuleConfig</a></dt>
<dd>
<div class="block">Swerve Module configuration class to define the motor CAN IDs and absolute encoder offset of a swerve module.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#swerveModuleLocation">swerveModuleLocation</a></span> - Variable in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Swerve Module location object relative to the center of the robot.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.SwerveModuleLocation.html#%3Cinit%3E()">SwerveModuleLocation()</a></span> - Constructor for enum frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve">SwerveModule.SwerveModuleLocation</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#SwerveModuleLocationToString(frc.robot.subsystems.swervedrive.swerve.SwerveModule.SwerveModuleLocation)">SwerveModuleLocationToString(SwerveModule.SwerveModuleLocation)</a></span> - Static method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Convert <a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.SwerveModuleLocation.html" title="enum in frc.robot.subsystems.swervedrive.swerve"><code>SwerveModule.SwerveModuleLocation</code></a> to <code>String</code> representation.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics"><span class="typeNameLink">SwerveModuleState2</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/package-summary.html">frc.robot.subsystems.swervedrive.swerve.kinematics</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html#%3Cinit%3E()">SwerveModuleState2()</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.kinematics.<a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveModuleState2</a></dt>
<dd>
<div class="block">Constructs a SwerveModuleState with zeros for speed and angle.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html#%3Cinit%3E(double,edu.wpi.first.math.geometry.Rotation2d)">SwerveModuleState2(double, Rotation2d)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.kinematics.<a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveModuleState2</a></dt>
<dd>
<div class="block">Constructs a SwerveModuleState.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html#%3Cinit%3E(double,edu.wpi.first.math.geometry.Rotation2d,double)">SwerveModuleState2(double, Rotation2d, double)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.kinematics.<a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveModuleState2</a></dt>
<dd>
<div class="block">Constructs a SwerveModuleState.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveModuleState)">SwerveModuleState2(SwerveModuleState)</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.kinematics.<a href="../frc/robot/subsystems/swervedrive/swerve/kinematics/SwerveModuleState2.html" title="class in frc.robot.subsystems.swervedrive.swerve.kinematics">SwerveModuleState2</a></dt>
<dd>
<div class="block">Constructs a SwerveModuleState with zeros for speed and angle.</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveMotor</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html#%3Cinit%3E()">SwerveMotor()</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveMotor</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveMotor.ModuleMotorType.html" title="enum in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveMotor.ModuleMotorType</span></a> - Enum in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Motor type for the swerve drive module</div>
</dd>
<dt><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve"><span class="typeNameLink">SwerveParser</span></a> - Class in <a href="../frc/robot/subsystems/swervedrive/swerve/package-summary.html">frc.robot.subsystems.swervedrive.swerve</a></dt>
<dd>
<div class="block">Swerve Drive JSON parser.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html#%3Cinit%3E()">SwerveParser()</a></span> - Constructor for class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveParser.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveParser</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html#synchronizeEncoders()">synchronizeEncoders()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveDrive.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveDrive</a></dt>
<dd>
<div class="block">Synchronize internal steering encoders with the absolute encoder.</div>
</dd>
<dt><span class="memberNameLink"><a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html#synchronizeSteeringEncoder()">synchronizeSteeringEncoder()</a></span> - Method in class frc.robot.subsystems.swervedrive.swerve.<a href="../frc/robot/subsystems/swervedrive/swerve/SwerveModule.html" title="class in frc.robot.subsystems.swervedrive.swerve">SwerveModule</a></dt>
<dd>
<div class="block">Synchronizes the internal encoder for the steering motor with the value from the absolute encoder.</div>
</dd>
</dl>
<a href="index-1.html">A</a>&nbsp;<a href="index-2.html">B</a>&nbsp;<a href="index-3.html">C</a>&nbsp;<a href="index-4.html">D</a>&nbsp;<a href="index-5.html">E</a>&nbsp;<a href="index-6.html">F</a>&nbsp;<a href="index-7.html">G</a>&nbsp;<a href="index-8.html">H</a>&nbsp;<a href="index-9.html">I</a>&nbsp;<a href="index-10.html">K</a>&nbsp;<a href="index-11.html">L</a>&nbsp;<a href="index-12.html">M</a>&nbsp;<a href="index-13.html">N</a>&nbsp;<a href="index-14.html">O</a>&nbsp;<a href="index-15.html">P</a>&nbsp;<a href="index-16.html">R</a>&nbsp;<a href="index-17.html">S</a>&nbsp;<a href="index-18.html">T</a>&nbsp;<a href="index-19.html">U</a>&nbsp;<a href="index-20.html">V</a>&nbsp;<a href="index-21.html">W</a>&nbsp;<a href="index-22.html">Z</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes</a>&nbsp;<a href="../allpackages-index.html">All&nbsp;Packages</a></div>
</main>
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
Updated javadocs to reflect changes
2023-01-31 10:52:13 -06:00
<li>Use</li>
First commit
2023-01-29 21:03:26 -06:00
<li><a href="../overview-tree.html">Tree</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Reference in New Issue Copy Permalink