mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
Fixed issue with angle optimization
This commit is contained in:
thenetworkgrinch
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>All Classes and Interfaces (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>All Classes and Interfaces</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-08-29">
|
||||
<meta name="description" content="class index">
|
||||
<meta name="generator" content="javadoc/AllClassesIndexWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="all-classes-index-page">
|
||||
@@ -35,7 +36,7 @@ loadScripts(document, 'script');</script>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="index-files/index-1.html">Index</a></li>
|
||||
<li><a href="help-doc.html#all-classes">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -111,6 +112,14 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Used to store doubles for motor configuration.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Used to store ints for motor configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Communicates with the NavX as the IMU.</div>
|
||||
@@ -123,42 +132,49 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Manages physics simulation for CTRE products.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/ctre/PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Holds information about a simulated device.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">SwerveIMU interface for the Pigeon2</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">SwerveIMU interface for the Pigeon.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Brushed motor control with SparkMax.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve
|
||||
modules..</div>
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
@@ -182,8 +198,7 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate
|
||||
estimation.</div>
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate estimation.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
@@ -203,8 +218,8 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules
|
||||
states from chassis speed.</div>
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
|
||||
speed.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
@@ -240,17 +255,29 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to
|
||||
achieve a more accurate estimation, originally made by Team 1466.</div>
|
||||
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to achieve a more
|
||||
accurate estimation, originally made by Team 1466.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Holds information about a simulated TalonFX.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Holds information about a simulated TalonSRX.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></div>
|
||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/ctre/VictorSPXSimProfile.html" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></div>
|
||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
||||
<div class="block">Holds information about a simulated VictorSPX.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>All Packages (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>All Packages</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-08-29">
|
||||
<meta name="description" content="package index">
|
||||
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="all-packages-index-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="index-files/index-1.html">Index</a></li>
|
||||
<li><a href="help-doc.html#all-packages">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
96
docs/constant-values.html
Normal file
96
docs/constant-values.html
Normal file
@@ -0,0 +1,96 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Constant Field Values</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-08-29">
|
||||
<meta name="description" content="summary of constants">
|
||||
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="constants-summary-page">
|
||||
<script type="text/javascript">var pathtoroot = "./";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="index-files/index-1.html">Index</a></li>
|
||||
<li><a href="help-doc.html#constant-values">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
|
||||
<section class="packages">
|
||||
<h2 title="Contents">Contents</h2>
|
||||
<ul>
|
||||
<li><a href="#swervelib.motors">swervelib.motors.*</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
<section class="constants-summary" id="swervelib.motors">
|
||||
<h2 title="swervelib.motors">swervelib.motors.*</h2>
|
||||
<ul class="block-list">
|
||||
<li>
|
||||
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Constant Field</div>
|
||||
<div class="table-header col-last">Value</div>
|
||||
<div class="col-first even-row-color"><code id="swervelib.motors.TalonFXSwerve.absoluteEncoder">private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#absoluteEncoder">absoluteEncoder</a></code></div>
|
||||
<div class="col-last even-row-color"><code>false</code></div>
|
||||
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonFXSwerve.factoryDefaultOccurred">private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last odd-row-color"><code>false</code></div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Constant Field</div>
|
||||
<div class="table-header col-last">Value</div>
|
||||
<div class="col-first even-row-color"><code id="swervelib.motors.TalonSRXSwerve.absoluteEncoder">private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonSRXSwerve.html#absoluteEncoder">absoluteEncoder</a></code></div>
|
||||
<div class="col-last even-row-color"><code>false</code></div>
|
||||
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonSRXSwerve.factoryDefaultOccurred">private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonSRXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last odd-row-color"><code>false</code></div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>API Help (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>API Help</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-08-29">
|
||||
<meta name="description" content="help">
|
||||
<meta name="generator" content="javadoc/HelpWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="help-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="index-files/index-1.html">Index</a></li>
|
||||
<li class="nav-bar-cell1-rev">Help</li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -67,6 +68,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="#class">Class or Interface</a></li>
|
||||
<li><a href="#doc-file">Other Files</a></li>
|
||||
<li><a href="#tree">Tree (Class Hierarchy)</a></li>
|
||||
<li><a href="#constant-values">Constant Field Values</a></li>
|
||||
<li><a href="#all-packages">All Packages</a></li>
|
||||
<li><a href="#all-classes">All Classes and Interfaces</a></li>
|
||||
<li><a href="#index">Index</a></li>
|
||||
@@ -76,7 +78,7 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="sub-title">
|
||||
<h2 id="help-navigation">Navigation</h2>
|
||||
Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-all.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>
|
||||
Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-files/index-1.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>
|
||||
<section class="help-section" id="help-search">
|
||||
<h3>Search</h3>
|
||||
<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p>
|
||||
@@ -154,6 +156,10 @@ The following sections describe the different kinds of pages in this collection.
|
||||
<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="help-section" id="constant-values">
|
||||
<h3>Constant Field Values</h3>
|
||||
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
|
||||
</section>
|
||||
<section class="help-section" id="all-packages">
|
||||
<h3>All Packages</h3>
|
||||
<p>The <a href="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p>
|
||||
@@ -164,7 +170,7 @@ The following sections describe the different kinds of pages in this collection.
|
||||
</section>
|
||||
<section class="help-section" id="index">
|
||||
<h3>Index</h3>
|
||||
<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p>
|
||||
<p>The <a href="index-files/index-1.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p>
|
||||
</section>
|
||||
</div>
|
||||
<hr>
|
||||
|
||||
287
docs/index-files/index-1.html
Normal file
287
docs/index-files/index-1.html
Normal file
@@ -0,0 +1,287 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>A-Index</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-08-29">
|
||||
<meta name="description" content="index: A">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:A">A</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">The Absolute Encoder for the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder for swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder inversion state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Whether the absolute encoder is inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderOffset" class="member-name-link">absoluteEncoderOffset</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder offset from 0 in degrees.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#addSlewRateLimiters(edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter)" class="member-name-link">addSlewRateLimiters(SlewRateLimiter, SlewRateLimiter, SlewRateLimiter)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Add slew rate limiters to all controls.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#addTalonFX(com.ctre.phoenix.motorcontrol.can.TalonFX,double,double)" class="member-name-link">addTalonFX(TalonFX, double, double)</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a TalonFX controller to the simulator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#addTalonFX(com.ctre.phoenix.motorcontrol.can.TalonFX,double,double,boolean)" class="member-name-link">addTalonFX(TalonFX, double, double, boolean)</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a TalonFX controller to the simulator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#addTalonSRX(com.ctre.phoenix.motorcontrol.can.TalonSRX,double,double)" class="member-name-link">addTalonSRX(TalonSRX, double, double)</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a TalonSRX controller to the simulator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#addTalonSRX(com.ctre.phoenix.motorcontrol.can.TalonSRX,double,double,boolean)" class="member-name-link">addTalonSRX(TalonSRX, double, double, boolean)</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a TalonSRX controller to the simulator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#addVictorSPX(com.ctre.phoenix.motorcontrol.can.VictorSPX)" class="member-name-link">addVictorSPX(VictorSPX)</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a VictorSPX controller to the simulator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double)" class="member-name-link">addVisionMeasurement(Pose2d, double)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a vision measurement to the Kalman Filter.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,double)" class="member-name-link">addVisionMeasurement(Pose2d, double, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
|
||||
the given timestamp of the vision measurement.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, boolean, Matrix<N3, N1>)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
|
||||
the given timestamp of the vision measurement.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, Matrix<N3, N1>)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Adds a vision measurement to the Kalman Filter.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html" class="type-name-link" title="class in swervelib.imu">ADIS16448Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">IMU Swerve class for the <code>ADIS16448_IMU</code> device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#%3Cinit%3E()" class="member-name-link">ADIS16448Swerve()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the ADIS16448 imu and reset default configurations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html" class="type-name-link" title="class in swervelib.imu">ADIS16470Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">IMU Swerve class for the <code>ADIS16470_IMU</code> device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#%3Cinit%3E()" class="member-name-link">ADIS16470Swerve()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the ADIS16470 imu and reset default configurations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html" class="type-name-link" title="class in swervelib.imu">ADXRS450Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">IMU Swerve class for the <code>ADXRS450_Gyro</code> device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#%3Cinit%3E()" class="member-name-link">ADXRS450Swerve()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the ADXRS450 imu and reset default configurations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">AnalogAbsoluteEncoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the Encoder given the analog input channel.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.AnalogInput)" class="member-name-link">AnalogAbsoluteEncoderSwerve(AnalogInput)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the Thrifty Encoder as a Swerve Absolute Encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html" class="type-name-link" title="class in swervelib.imu">AnalogGyroSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a IMU for <code>AnalogGyro</code> devices, only uses yaw.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#%3Cinit%3E(int)" class="member-name-link">AnalogGyroSwerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Analog port in which the gyroscope is connected.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor device configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor inversion state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The PIDF with Integral Zone used for the angle motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#angleEncoderPulsePerRevolution" class="member-name-link">angleEncoderPulsePerRevolution</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The angle encoder pulse per revolution override.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleEncoderPulsePerRotation" class="member-name-link">angleEncoderPulsePerRotation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor encoder pulse per rotation.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleGearRatio" class="member-name-link">angleGearRatio</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle gear ratio.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#angleJoystickRadiusDeadband" class="member-name-link">angleJoystickRadiusDeadband</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The minimum radius of the angle control joystick to allow for heading adjustment of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#angleJoyStickRadiusDeadband" class="member-name-link">angleJoyStickRadiusDeadband</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">hypotenuse deadband for the robot angle control joystick.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#angleLimiter" class="member-name-link">angleLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>SlewRateLimiter</code> for angular movement in radians/second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorCurrentLimit" class="member-name-link">angleMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Current limits for the Swerve Module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorEncoderPulsePerRevolution" class="member-name-link">angleMotorEncoderPulsePerRevolution</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">The integrated encoder pulse per revolution.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#angleMotorFreeSpeedRPM" class="member-name-link">angleMotorFreeSpeedRPM</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">DEPRECATED: No longer needed, tune <a href="../swervelib/parser/json/PhysicalPropertiesJson.html#moduleFeedForwardClosedLoop"><code>PhysicalPropertiesJson.moduleFeedForwardClosedLoop</code></a> instead.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorInverted" class="member-name-link">angleMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">State of inversion of the angle motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorRampRate" class="member-name-link">angleMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle offset in degrees for the Swerve Module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle offset from the absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#anglePIDF" class="member-name-link">anglePIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#antiJitter(swervelib.math.SwerveModuleState2,swervelib.math.SwerveModuleState2,double)" class="member-name-link">antiJitter(SwerveModuleState2, SwerveModuleState2, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Perform anti-jitter within modules if the speed requested is too low.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#applyDeadband(double,boolean,double)" class="member-name-link">applyDeadband(double, boolean, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Algebraically apply a deadband using a piece wise function.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Max module speed in meters per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Max module speed in meters per second.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
65
docs/index-files/index-10.html
Normal file
65
docs/index-files/index-10.html
Normal file
@@ -0,0 +1,65 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>K-Index</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-08-29">
|
||||
<meta name="description" content="index: K">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:K">K</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveDrive.html#kinematics" class="member-name-link">kinematics</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Kinematics object utilizing second order kinematics.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
107
docs/index-files/index-11.html
Normal file
107
docs/index-files/index-11.html
Normal file
@@ -0,0 +1,107 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>L-Index</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-08-29">
|
||||
<meta name="description" content="index: L">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:L">L</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveController.html#lastAngleScalar" class="member-name-link">lastAngleScalar</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Last angle as a scalar [-1,1] the robot was set to.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">The last heading set in radians.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#lastState" class="member-name-link">lastState</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Last swerve module state applied.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#lastTime" class="member-name-link">lastTime</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">The last time the timer was read, used to determine position changes.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#lastTime" class="member-name-link">lastTime</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Last time queried.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#left" class="member-name-link">left</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Location of the swerve module in inches from the center of the robot vertically.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity(Translation2d, ChassisSpeeds, Pose2d, double, double, List<Matter>, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>SwerveMath.calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#location" class="member-name-link">location</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The location of the swerve module from the center of the robot in inches.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
|
||||
<dd>
|
||||
<div class="block">Location JSON parsed class.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#%3Cinit%3E()" class="member-name-link">LocationJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#lockPose()" class="member-name-link">lockPose()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#LOW" class="member-name-link">LOW</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">Low telemetry data, only post the robot position on the field.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
314
docs/index-files/index-12.html
Normal file
314
docs/index-files/index-12.html
Normal file
@@ -0,0 +1,314 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>M-Index</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-08-29">
|
||||
<meta name="description" content="index: M">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:M">M</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_forwardKinematics" class="member-name-link">m_forwardKinematics</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Forward kinematics matrix.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_gyroOffset" class="member-name-link">m_gyroOffset</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_inverseKinematics" class="member-name-link">m_inverseKinematics</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Inverse kinematics matrix.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_kinematics" class="member-name-link">m_kinematics</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve drive kinematics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#m_kinematics" class="member-name-link">m_kinematics</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve drive kinematics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_moduleAccelTimer" class="member-name-link">m_moduleAccelTimer</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_modules" class="member-name-link">m_modules</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Location of each swerve module in meters.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_moduleStates" class="member-name-link">m_moduleStates</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve module states.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_numModules" class="member-name-link">m_numModules</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_numModules" class="member-name-link">m_numModules</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#m_numModules" class="member-name-link">m_numModules</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#m_odometry" class="member-name-link">m_odometry</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Enhanced swerve drive odometry.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#m_poseBuffer" class="member-name-link">m_poseBuffer</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Interpolation buffer.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_poseMeters" class="member-name-link">m_poseMeters</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Estimated pose.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_prevChassisSpeeds" class="member-name-link">m_prevChassisSpeeds</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_prevCoR" class="member-name-link">m_prevCoR</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Previous CoR</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_previousAngle" class="member-name-link">m_previousAngle</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Previous gyroscope angle.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_previousModulePositions" class="member-name-link">m_previousModulePositions</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Previous swerve module positions.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#m_prevModuleAccelTime" class="member-name-link">m_prevModuleAccelTime</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#m_q" class="member-name-link">m_q</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Matrix quotient.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#m_visionK" class="member-name-link">m_visionK</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Vision standard deviations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#m_zeroModuleStates" class="member-name-link">m_zeroModuleStates</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Zero module states.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#MACHINE" class="member-name-link">MACHINE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">Only send the machine readable data related to swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/Matter.html#mass" class="member-name-link">mass</a> - Variable in class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
|
||||
<dd>
|
||||
<div class="block">Mass in kg of object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/Matter.html#massMoment()" class="member-name-link">massMoment()</a> - Method in class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the center mass of the object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
||||
<dd>
|
||||
<div class="block">Object with significant mass that needs to be taken into account.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/Matter.html#%3Cinit%3E(edu.wpi.first.math.geometry.Translation3d,double)" class="member-name-link">Matter(Translation3d, double)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct an object representing some significant matter on the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#max" class="member-name-link">max</a> - Variable in class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
|
||||
<dd>
|
||||
<div class="block">Maximum value.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#maxAngularVelocity" class="member-name-link">maxAngularVelocity</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Maximum angular velocity in rad/s</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#maxAngularVelocity" class="member-name-link">maxAngularVelocity</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The maximum achievable angular velocity of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Maximum robot speed in feet per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Maximum robot speed in meters per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Max module speed in meters per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Maximum robot speed in meters per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#maxSpeed" class="member-name-link">maxSpeed</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The maximum achievable speed of the modules, used to adjust the size of the vectors.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredChassisSpeeds" class="member-name-link">measuredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The maximum achievable angular velocity of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredStates" class="member-name-link">measuredStates</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">An array of rotation and velocity values describing the measured state of each swerve module</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#min" class="member-name-link">min</a> - Variable in class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
|
||||
<dd>
|
||||
<div class="block">Minimum value.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#moduleConfigs" class="member-name-link">moduleConfigs</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Module number mapped to the JSON name.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#moduleCount" class="member-name-link">moduleCount</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Number of modules on the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#moduleCount" class="member-name-link">moduleCount</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The number of swerve modules</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#moduleFeedForwardClosedLoop" class="member-name-link">moduleFeedForwardClosedLoop</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
|
||||
your drive train does not drift towards the direction you are rotating while you translate.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#%3Cinit%3E()" class="member-name-link">ModuleJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#moduleJsons" class="member-name-link">moduleJsons</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Array holding the module jsons given in <a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json"><code>SwerveDriveJson</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#moduleLocation" class="member-name-link">moduleLocation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve module location relative to the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#moduleLocationsMeters" class="member-name-link">moduleLocationsMeters</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Module locations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#moduleNumber" class="member-name-link">moduleNumber</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Module number for kinematics, usually 0 to 3.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#modulePositions" class="member-name-link">modulePositions</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#modules" class="member-name-link">modules</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Module JSONs in order clockwise order starting from front left.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#modules" class="member-name-link">modules</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#moduleStateOptimization" class="member-name-link">moduleStateOptimization</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Enable <a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> optimizations so the angle is reversed and speed is reversed to ensure the module
|
||||
never turns more than 90deg.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle volt-meter-per-second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
|
||||
your drive train does not drift towards the direction you are rotating while you translate.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">SparkMAX Instance.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">SparkMAX Instance.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">TalonFX motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">TalonSRX motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block">Used to store doubles for motor configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#%3Cinit%3E()" class="member-name-link">MotorConfigDouble()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
||||
<dd>
|
||||
<div class="block">Default constructor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#%3Cinit%3E(double,double)" class="member-name-link">MotorConfigDouble(double, double)</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
||||
<dd>
|
||||
<div class="block">Default constructor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigInt</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block">Used to store ints for motor configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#%3Cinit%3E()" class="member-name-link">MotorConfigInt()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
||||
<dd>
|
||||
<div class="block">Default constructor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#%3Cinit%3E(int,int)" class="member-name-link">MotorConfigInt(int, int)</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
||||
<dd>
|
||||
<div class="block">Default constructor with values.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
89
docs/index-files/index-13.html
Normal file
89
docs/index-files/index-13.html
Normal file
@@ -0,0 +1,89 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>N-Index</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-08-29">
|
||||
<meta name="description" content="index: N">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:N">N</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#name" class="member-name-link">name</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Name for the swerve module for telemetry.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html" class="type-name-link" title="class in swervelib.imu">NavXSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">Communicates with the NavX as the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.SerialPort.Port)" class="member-name-link">NavXSwerve(SerialPort.Port)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructor for the NavX swerve.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#nominalVoltage" class="member-name-link">nominalVoltage</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#nominalVoltage" class="member-name-link">nominalVoltage</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#NONE" class="member-name-link">NONE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">No telemetry data is sent back.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#normalizeAngle(double)" class="member-name-link">normalizeAngle(double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Normalize an angle to be within 0 to 360.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
114
docs/index-files/index-14.html
Normal file
114
docs/index-files/index-14.html
Normal file
@@ -0,0 +1,114 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>O-Index</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-08-29">
|
||||
<meta name="description" content="index: O">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:O">O</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the ADIS16448.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the ADIS16470.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the ADXRS450.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the analog gyro.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the NavX.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the Pigeon 2.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Offset for the Pigeon.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#omegaRadPerSecond" class="member-name-link">omegaRadPerSecond</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Rad per sec</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#openJson(java.io.File)" class="member-name-link">openJson(File)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Open JSON file.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Optimal voltage to compensate to and base feedforward calculations off of.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#optimalVoltage" class="member-name-link">optimalVoltage</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Optimal voltage of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#optimize(swervelib.math.SwerveModuleState2,edu.wpi.first.math.geometry.Rotation2d,swervelib.math.SwerveModuleState2,double)" class="member-name-link">optimize(SwerveModuleState2, Rotation2d, SwerveModuleState2, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Minimize the change in heading the desired swerve module state would require by potentially reversing the direction
|
||||
the wheel spins.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#output" class="member-name-link">output</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">The PIDF output range.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
187
docs/index-files/index-15.html
Normal file
187
docs/index-files/index-15.html
Normal file
@@ -0,0 +1,187 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>P-Index</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-08-29">
|
||||
<meta name="description" content="index: P">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:P">P</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#p" class="member-name-link">p</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Proportional Gain for PID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Physical characteristics of the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#physicalPropertiesJson" class="member-name-link">physicalPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Parsed modules/physicalproperties.json</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PhysicalPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block"><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#%3Cinit%3E()" class="member-name-link">PhysicalPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim</a> - Class in <a href="../swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a></dt>
|
||||
<dd>
|
||||
<div class="block">Manages physics simulation for CTRE products.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#%3Cinit%3E()" class="member-name-link">PhysicsSim()</a> - Constructor for class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a> - Class in <a href="../swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a></dt>
|
||||
<dd>
|
||||
<div class="block">Holds information about a simulated device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E()" class="member-name-link">PIDFConfig()</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Used when parsing PIDF values from JSON.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double)" class="member-name-link">PIDFConfig(double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double)" class="member-name-link">PIDFConfig(double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double)" class="member-name-link">PIDFConfig(double, double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double,double)" class="member-name-link">PIDFConfig(double, double, double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Parsed modules/pidfproperties.json</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#%3Cinit%3E()" class="member-name-link">PIDFPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a> - Class in <a href="../swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></dt>
|
||||
<dd>
|
||||
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#%3Cinit%3E()" class="member-name-link">PIDFRange()</a> - Constructor for class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html" class="type-name-link" title="class in swervelib.imu">Pigeon2Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">SwerveIMU interface for the Pigeon2</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int)" class="member-name-link">Pigeon2Swerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Generate the SwerveIMU for pigeon.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int,java.lang.String)" class="member-name-link">Pigeon2Swerve(int, String)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Generate the SwerveIMU for pigeon.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html" class="type-name-link" title="class in swervelib.imu">PigeonSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">SwerveIMU interface for the Pigeon.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#%3Cinit%3E(int)" class="member-name-link">PigeonSwerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Generate the SwerveIMU for pigeon.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope(double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Put an angle within the 360 deg scope of a reference.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#PoseLog(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">PoseLog(Pose2d)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Logical inverse of the Pose exponential from 254.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#poseMeters" class="member-name-link">poseMeters</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/Matter.html#position" class="member-name-link">position</a> - Variable in class swervelib.math.<a href="../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></dt>
|
||||
<dd>
|
||||
<div class="block">Position in meters from robot center in 3d space.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Position" class="member-name-link">Position</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Slot 1, used for position PID's.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#positionConversionFactor" class="member-name-link">positionConversionFactor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#positionConversionFactor" class="member-name-link">positionConversionFactor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#postTrajectory(edu.wpi.first.math.trajectory.Trajectory)" class="member-name-link">postTrajectory(Trajectory)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Post the trajectory to the field</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
65
docs/index-files/index-16.html
Normal file
65
docs/index-files/index-16.html
Normal file
@@ -0,0 +1,65 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Q-Index</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-08-29">
|
||||
<meta name="description" content="index: Q">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:Q">Q</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveModule.html#queueSynchronizeEncoders()" class="member-name-link">queueSynchronizeEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queue synchronization of the integrated angle encoder with the absolute encoder.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
122
docs/index-files/index-17.html
Normal file
122
docs/index-files/index-17.html
Normal file
@@ -0,0 +1,122 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>R-Index</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-08-29">
|
||||
<meta name="description" content="index: R">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:R">R</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#rampRate" class="member-name-link">rampRate</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The minimum number of seconds to take for the motor to go from 0 to full throttle.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#random(double)" class="member-name-link">random(double)</a> - Static method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#random(double,double)" class="member-name-link">random(double, double)</a> - Static method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#readingError" class="member-name-link">readingError</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd>
|
||||
<div class="block">Last angle reading was faulty.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#replaceSwerveModuleFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">replaceSwerveModuleFeedforward(SimpleMotorFeedforward)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Setup the swerve module feedforward.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#resetEncoders()" class="member-name-link">resetEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a reboot, like in
|
||||
autonomous.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#resetOdometry(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetOdometry(Pose2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Resets odometry to the given pose.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#resetPosition(edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D,edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetPosition(Rotation2d, SwerveModulePosition[], Pose2d)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Resets the robot's position on the field.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#resetPosition(edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D,edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetPosition(Rotation2d, SwerveModulePosition[], Pose2d)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Resets the robot's position on the field.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#robotRotation" class="member-name-link">robotRotation</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The robot's current rotation based on odometry or gyro readings</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#rotationUnit" class="member-name-link">rotationUnit</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The units of the module rotations and robot rotation</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#run()" class="member-name-link">run()</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Runs the simulator: - enable the robot - simulate sensors</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html#run()" class="member-name-link">run()</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#run()" class="member-name-link">run()</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#run()" class="member-name-link">run()</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html#run()" class="member-name-link">run()</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Runs the simulation profile.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
702
docs/index-files/index-18.html
Normal file
702
docs/index-files/index-18.html
Normal file
@@ -0,0 +1,702 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>S-Index</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-08-29">
|
||||
<meta name="description" content="index: S">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:S">S</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the percentage output.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the percentage output.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the percentage output.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the percentage output.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the percentage output.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#setAngle(double)" class="member-name-link">setAngle(double)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#setAngle(double)" class="member-name-link">setAngle(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the angle for the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set chassis speeds with closed-loop velocity control and second order kinematics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</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><a href="../swervelib/motors/SparkMaxSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</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><a href="../swervelib/motors/SwerveMotor.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">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><a href="../swervelib/motors/TalonFXSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</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><a href="../swervelib/motors/TalonSRXSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</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><a href="../swervelib/SwerveModule.html#setDesiredState(swervelib.math.SwerveModuleState2,boolean,boolean)" class="member-name-link">setDesiredState(SwerveModuleState2, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the desired state of the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setGyro(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyro(Rotation3d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setGyroOffset(Rotation3d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro scope offset to a desired known rotation.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the motor to be inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the motor to be inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the motor to be inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the motor to be inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the motor to be inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum rate the open/closed loop output can change by.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#setMaximumAngularVelocity(double)" class="member-name-link">setMaximumAngularVelocity(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set a new maximum angular velocity that is different from the auto-generated one.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
|
||||
<a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
|
||||
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState2[], boolean)</code></a> function and
|
||||
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double,boolean)" class="member-name-link">setMaximumSpeed(double, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="../swervelib/parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
|
||||
<a href="../swervelib/parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
|
||||
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState2[], boolean)</code></a> function and
|
||||
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeeds(double,double,double)" class="member-name-link">setMaximumSpeeds(double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the maximum speeds for desaturation.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setModuleStateOptimization(boolean)" class="member-name-link">setModuleStateOptimization(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure whether the <a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> will be optimized to prevent spinning more than 90deg.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)" class="member-name-link">setModuleStates(SwerveModuleState2[], boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the module states (azimuth and velocity) directly.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the idle mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the idle mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the idle mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the idle mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the idle mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the brake mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setMotorIdleMode(boolean)" class="member-name-link">setMotorIdleMode(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Sets the drive motors to brake/coast mode.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the gyro offset.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the integrated encoder position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the integrated encoder position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the integrated encoder position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the integrated encoder position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the integrated encoder position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)" class="member-name-link">setRawModuleStates(SwerveModuleState2[], boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the module states (azimuth and velocity) directly.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the closed loop PID controller reference point.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#setVisionMeasurementStdDevs(edu.wpi.first.math.Matrix)" class="member-name-link">setVisionMeasurementStdDevs(Matrix<N3, N1>)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Sets the pose estimator's trust of global measurements.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#sim" class="member-name-link">sim</a> - Static variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#simIMU" class="member-name-link">simIMU</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Simulation of the swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#simModule" class="member-name-link">simModule</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Simulated swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html#%3Cinit%3E()" class="member-name-link">SimProfile()</a> - Constructor for class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Simulation" class="member-name-link">Simulation</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Slot 3, used arbitrarily.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#sizeFrontBack" class="member-name-link">sizeFrontBack</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The distance between the front and back modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#sizeLeftRight" class="member-name-link">sizeLeftRight</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The distance between the left and right modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx()</a> - Constructor for enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
||||
<dd>
|
||||
<div class="block">Brushed motor control with SparkMax.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#%3Cinit%3E(int,boolean,com.revrobotics.SparkMaxRelativeEncoder.Type,int,boolean)" class="member-name-link">SparkMaxBrushedMotorSwerve(int, boolean, SparkMaxRelativeEncoder.Type, int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Initialize the <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> as a <code>CANSparkMax</code> connected to a Brushless Motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkMax,boolean,com.revrobotics.SparkMaxRelativeEncoder.Type,int,boolean)" class="member-name-link">SparkMaxBrushedMotorSwerve(CANSparkMax, boolean, SparkMaxRelativeEncoder.Type, int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Initialize the swerve motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
||||
<dd>
|
||||
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#%3Cinit%3E(swervelib.motors.SwerveMotor,int)" class="member-name-link">SparkMaxEncoderSwerve(SwerveMotor, int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the <code>AbsoluteEncoder</code> object as a duty cycle.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
||||
<dd>
|
||||
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">SparkMaxSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Initialize the <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> as a <code>CANSparkMax</code> connected to a Brushless Motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkMax,boolean)" class="member-name-link">SparkMaxSwerve(CANSparkMax, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Initialize the swerve motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a> - Enum Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
||||
<dd>
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#state" class="member-name-link">state</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Current simulated swerve module state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#stateStdDevs" class="member-name-link">stateStdDevs</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Trustworthiness of the internal model of how motors should be moving Measured in expected standard deviation
|
||||
(meters of position and degrees of rotation)</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#%3Cinit%3E()" class="member-name-link">SwerveAbsoluteEncoder()</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#swerveController" class="member-name-link">swerveController</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve controller for controlling heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html" class="type-name-link" title="class in swervelib">SwerveController</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
|
||||
<dd>
|
||||
<div class="block">Controller class used to convert raw inputs into robot speeds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#%3Cinit%3E(swervelib.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveController(SwerveControllerConfiguration)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot based on controller
|
||||
input.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveControllerConfiguration</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Controller configuration class which is used to configure <a href="../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the swerve controller configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the swerve controller configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html" class="type-name-link" title="class in swervelib">SwerveDrive</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveDrive(SwerveDriveConfiguration, SwerveControllerConfiguration)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new swerve drivebase subsystem.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#swerveDriveConfiguration" class="member-name-link">swerveDriveConfiguration</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve drive configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveDriveConfiguration</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveModuleConfiguration%5B%5D,swervelib.imu.SwerveIMU,double,boolean)" class="member-name-link">SwerveDriveConfiguration(SwerveModuleConfiguration[], SwerveIMU, double, boolean)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create swerve drive configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#swerveDriveJson" class="member-name-link">swerveDriveJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Parsed swervedrive.json</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html" class="type-name-link" title="class in swervelib.parser.json">SwerveDriveJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block"><a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#%3Cinit%3E()" class="member-name-link">SwerveDriveJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html" class="type-name-link" title="class in swervelib.math">SwerveDriveOdometry2</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate estimation.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D)" class="member-name-link">SwerveDriveOdometry2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[])</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a SwerveDriveOdometry object with the default pose at the origin.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D,edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">SwerveDriveOdometry2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[], Pose2d)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a SwerveDriveOdometry object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#swerveDrivePoseEstimator" class="member-name-link">swerveDrivePoseEstimator</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve odometry.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html" class="type-name-link" title="class in swervelib.telemetry">SwerveDriveTelemetry</a> - Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">Telemetry to describe the <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> following frc-web-components.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#%3Cinit%3E()" class="member-name-link">SwerveDriveTelemetry()</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" class="type-name-link" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a> - Enum Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">Verbosity of telemetry data sent back.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html" class="type-name-link" title="class in swervelib.imu">SwerveIMU</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#%3Cinit%3E()" class="member-name-link">SwerveIMU()</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveIMUSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Simulation for <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveIMUSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the swerve drive IMU simulation.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html" class="type-name-link" title="class in swervelib.math">SwerveKinematics2</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</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><a href="../swervelib/math/SwerveKinematics2.html#%3Cinit%3E(edu.wpi.first.math.geometry.Translation2d...)" class="member-name-link">SwerveKinematics2(Translation2d...)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a swerve drive kinematics object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/package-summary.html">swervelib</a> - package swervelib</dt>
|
||||
<dd>
|
||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a> - package swervelib.encoders</dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/package-summary.html">swervelib.imu</a> - package swervelib.imu</dt>
|
||||
<dd>
|
||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/package-summary.html">swervelib.math</a> - package swervelib.math</dt>
|
||||
<dd>
|
||||
<div class="block">Mathematics for swerve drives.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/package-summary.html">swervelib.motors</a> - package swervelib.motors</dt>
|
||||
<dd>
|
||||
<div class="block">Swerve motor controller wrappers which implement <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/package-summary.html">swervelib.parser</a> - package swervelib.parser</dt>
|
||||
<dd>
|
||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a> - package swervelib.parser.deserializer</dt>
|
||||
<dd>
|
||||
<div class="block">Deserialize specific variables for outside the parser.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a> - package swervelib.parser.json</dt>
|
||||
<dd>
|
||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a> - package swervelib.parser.json.modules</dt>
|
||||
<dd>
|
||||
<div class="block">JSON Mapped Configuration types for modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a> - package swervelib.simulation</dt>
|
||||
<dd>
|
||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a> - package swervelib.simulation.ctre</dt>
|
||||
<dd>
|
||||
<div class="block">CTRE Physics Simulator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a> - package swervelib.telemetry</dt>
|
||||
<dd>
|
||||
<div class="block">Telemetry package for sending data to NT4 or SmartDashboard.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html" class="type-name-link" title="class in swervelib.math">SwerveMath</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
||||
<dd>
|
||||
<div class="block">Mathematical functions which pertain to swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#%3Cinit%3E()" class="member-name-link">SwerveMath()</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html" class="type-name-link" title="class in swervelib">SwerveModule</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
|
||||
<dd>
|
||||
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#%3Cinit%3E(int,swervelib.parser.SwerveModuleConfiguration)" class="member-name-link">SwerveModule(int, SwerveModuleConfiguration)</a> - Constructor for class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the swerve module and initialize the swerve module motors and absolute encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveModuleConfiguration</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Module configuration class which is used to configure <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,double,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, boolean, boolean, boolean, double, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct a configuration object for swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#%3Cinit%3E(swervelib.motors.SwerveMotor,swervelib.motors.SwerveMotor,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, String)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct a configuration object for swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" class="type-name-link" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(double,double,double,double,double,int,int)" class="member-name-link">SwerveModulePhysicalCharacteristics(double, double, double, double, double, int, int)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the swerve module physical characteristics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(double,double,double,double,double,int,int,double,double,int,int,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(double, double, double, double, double, int, int, double, double, int, int, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the swerve module physical characteristics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#swerveModules" class="member-name-link">swerveModules</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveModuleSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Class to hold simulation data for <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveModuleSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create simulation class and initialize module at 0.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html" class="type-name-link" title="class in swervelib.math">SwerveModuleState2</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
||||
<dd>
|
||||
<div class="block">Second order kinematics swerve module state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#%3Cinit%3E()" class="member-name-link">SwerveModuleState2()</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a SwerveModuleState with zeros for speed and angle.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#%3Cinit%3E(double,edu.wpi.first.math.geometry.Rotation2d,double)" class="member-name-link">SwerveModuleState2(double, Rotation2d, double)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a SwerveModuleState.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveModuleState,double)" class="member-name-link">SwerveModuleState2(SwerveModuleState, double)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a <a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> based on the <code>SwerveModuleState</code> with the radians per second defined.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html" class="type-name-link" title="class in swervelib.motors">SwerveMotor</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#%3Cinit%3E()" class="member-name-link">SwerveMotor()</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html" class="type-name-link" title="class in swervelib.parser">SwerveParser</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#%3Cinit%3E(java.io.File)" class="member-name-link">SwerveParser(File)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct a swerve parser.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to achieve a more
|
||||
accurate estimation, originally made by Team 1466.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D,edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">SwervePoseEstimator2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[], Pose2d)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a SwerveDrivePoseEstimator with default standard deviations for the model and vision measurements.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D,edu.wpi.first.math.geometry.Pose2d,edu.wpi.first.math.Matrix,edu.wpi.first.math.Matrix)" class="member-name-link">SwervePoseEstimator2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[], Pose2d, Matrix<N3, N1>, Matrix<N3, N1>)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs a SwerveDrivePoseEstimator.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
||||
<dd>
|
||||
<div class="block">Represents an odometry record.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Encoder synchronization queued.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
143
docs/index-files/index-19.html
Normal file
143
docs/index-files/index-19.html
Normal file
@@ -0,0 +1,143 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>T-Index</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-08-29">
|
||||
<meta name="description" content="index: T">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:T">T</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a> - Class in <a href="../swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a></dt>
|
||||
<dd>
|
||||
<div class="block">Holds information about a simulated TalonFX.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.TalonFX,double,double,boolean)" class="member-name-link">TalonFXSimProfile(TalonFX, double, double, boolean)</a> - Constructor for class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new simulation profile for a TalonFX device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html" class="type-name-link" title="class in swervelib.motors">TalonFXSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">TalonFXSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the TalonFX swerve motor given the ID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#%3Cinit%3E(int,java.lang.String,boolean)" class="member-name-link">TalonFXSwerve(int, String, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the TalonFX swerve motor given the ID and CANBus.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.WPI_TalonFX,boolean)" class="member-name-link">TalonFXSwerve(WPI_TalonFX, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructor for TalonFX swerve motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a> - Class in <a href="../swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a></dt>
|
||||
<dd>
|
||||
<div class="block">Holds information about a simulated TalonSRX.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.TalonSRX,double,double,boolean)" class="member-name-link">TalonSRXSimProfile(TalonSRX, double, double, boolean)</a> - Constructor for class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new simulation profile for a TalonSRX device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html" class="type-name-link" title="class in swervelib.motors">TalonSRXSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">TalonSRXSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Construct the TalonSRX swerve motor given the ID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX,boolean)" class="member-name-link">TalonSRXSwerve(WPI_TalonSRX, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructor for TalonSRX swerve motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#%3Cinit%3E()" class="member-name-link">TelemetryVerbosity()</a> - Constructor for enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#thetaController" class="member-name-link">thetaController</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">PID Controller for the robot heading.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#timer" class="member-name-link">timer</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Main timer to control movement estimations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#timer" class="member-name-link">timer</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Main timer to simulate the passage of time.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#toChassisSpeeds(swervelib.math.SwerveModuleState2...)" class="member-name-link">toChassisSpeeds(SwerveModuleState2...)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Performs forward kinematics to return the resulting chassis state from the given module states.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#toSwerveModuleState()" class="member-name-link">toSwerveModuleState()</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Convert to a <code>SwerveModuleState</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#toSwerveModuleStates(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">toSwerveModuleStates(ChassisSpeeds)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Performs inverse kinematics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#toSwerveModuleStates(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">toSwerveModuleStates(ChassisSpeeds, Translation2d)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Performs inverse kinematics to return the module states from a desired chassis velocity.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#toTwist2d(edu.wpi.first.math.kinematics.SwerveModulePosition...)" class="member-name-link">toTwist2d(SwerveModulePosition...)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Performs forward kinematics to return the resulting chassis state from the given module states.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#type" class="member-name-link">type</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The device type, e.g.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
91
docs/index-files/index-2.html
Normal file
91
docs/index-files/index-2.html
Normal file
@@ -0,0 +1,91 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>B-Index</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-08-29">
|
||||
<meta name="description" content="index: B">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:B">B</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#bigInverseKinematics" class="member-name-link">bigInverseKinematics</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Second order kinematics inverse matrix.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">BoolMotorJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
|
||||
<dd>
|
||||
<div class="block">Inverted motor JSON parsed class.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#%3Cinit%3E()" class="member-name-link">BoolMotorJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
90
docs/index-files/index-20.html
Normal file
90
docs/index-files/index-20.html
Normal file
@@ -0,0 +1,90 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>U-Index</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-08-29">
|
||||
<meta name="description" content="index: U">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:U">U</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#update(edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D)" class="member-name-link">update(Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[])</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Updates the robot's position on the field using forward kinematics and integration of the pose over time.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#update(edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D)" class="member-name-link">update(Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[])</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Updates the pose estimator with wheel encoder and gyro information.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#updateData()" class="member-name-link">updateData()</a> - Static method in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">Upload data to smartdashboard</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#updateOdometry()" class="member-name-link">updateOdometry()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update odometry should be run every loop.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#updateOdometry(swervelib.math.SwerveKinematics2,swervelib.math.SwerveModuleState2%5B%5D,edu.wpi.first.math.geometry.Pose2d%5B%5D,edu.wpi.first.wpilibj.smartdashboard.Field2d)" class="member-name-link">updateOdometry(SwerveKinematics2, SwerveModuleState2[], Pose2d[], Field2d)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update the odometry of the simulated <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> and post the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>
|
||||
states to the <code>Field2d</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#updateStateAndPosition(swervelib.math.SwerveModuleState2)" class="member-name-link">updateStateAndPosition(SwerveModuleState2)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Update the position and state of the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#updateWithTime(double,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D)" class="member-name-link">updateWithTime(double, Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[])</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Updates the pose estimator with wheel encoder and gyro information.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
104
docs/index-files/index-21.html
Normal file
104
docs/index-files/index-21.html
Normal file
@@ -0,0 +1,104 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>V-Index</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-08-29">
|
||||
<meta name="description" content="index: V">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:V">V</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns an array containing the constants of this enum class, in
|
||||
the order they are declared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns an array containing the constants of this enum class, in
|
||||
the order they are declared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Velocity" class="member-name-link">Velocity</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
||||
<dd>
|
||||
<div class="block">Slot 2, used for velocity PID's.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#velocityPIDF" class="member-name-link">velocityPIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF configuration options for the drive motor closed-loop PID controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#verbosity" class="member-name-link">verbosity</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The current telemetry verbosity level.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a> - Class in <a href="../swervelib/simulation/ctre/package-summary.html">swervelib.simulation.ctre</a></dt>
|
||||
<dd>
|
||||
<div class="block">Holds information about a simulated VictorSPX.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html#%3Cinit%3E(com.ctre.phoenix.motorcontrol.can.VictorSPX)" class="member-name-link">VictorSPXSimProfile(VictorSPX)</a> - Constructor for class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Creates a new simulation profile for a VictorSPX device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Trustworthiness of the vision system Measured in expected standard deviation (meters of position and degrees of
|
||||
rotation)</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
85
docs/index-files/index-22.html
Normal file
85
docs/index-files/index-22.html
Normal file
@@ -0,0 +1,85 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>W-Index</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-08-29">
|
||||
<meta name="description" content="index: W">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:W">W</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#wheelDiameter" class="member-name-link">wheelDiameter</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Wheel diameter in inches.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#wheelDiameter" class="member-name-link">wheelDiameter</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Wheel diameter in meters.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#wheelGripCoefficientOfFriction" class="member-name-link">wheelGripCoefficientOfFriction</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The grip tape coefficient of friction on carpet.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#wheelGripCoefficientOfFriction" class="member-name-link">wheelGripCoefficientOfFriction</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Wheel grip tape coefficient of friction on carpet, as described by the vendor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#wheelLocations" class="member-name-link">wheelLocations</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The number of swerve modules</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#withinHypotDeadband(double,double)" class="member-name-link">withinHypotDeadband(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the hypot deadband and check if the joystick is within it.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
69
docs/index-files/index-23.html
Normal file
69
docs/index-files/index-23.html
Normal file
@@ -0,0 +1,69 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>X-Index</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-08-29">
|
||||
<meta name="description" content="index: X">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:X">X</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#x" class="member-name-link">x</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Location of the swerve module in inches from the center of the robot horizontally.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#xLimiter" class="member-name-link">xLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>SlewRateLimiter</code> for movement in the X direction in meters/second.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
69
docs/index-files/index-24.html
Normal file
69
docs/index-files/index-24.html
Normal file
@@ -0,0 +1,69 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Y-Index</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-08-29">
|
||||
<meta name="description" content="index: Y">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:Y">Y</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#y" class="member-name-link">y</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Location of the swerve module in inches from the center of the robot vertically.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#yLimiter" class="member-name-link">yLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>SlewRateLimiter</code> for movement in the Y direction in meters/second.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
65
docs/index-files/index-25.html
Normal file
65
docs/index-files/index-25.html
Normal file
@@ -0,0 +1,65 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Z-Index</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-08-29">
|
||||
<meta name="description" content="index: Z">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:Z">Z</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveDrive.html#zeroGyro()" class="member-name-link">zeroGyro()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
93
docs/index-files/index-26.html
Normal file
93
docs/index-files/index-26.html
Normal file
@@ -0,0 +1,93 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>_-Index</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-08-29">
|
||||
<meta name="description" content="index: _">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:_">_</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#_accelToFullTime" class="member-name-link">_accelToFullTime</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#_accelToFullTime" class="member-name-link">_accelToFullTime</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#_falcon" class="member-name-link">_falcon</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#_fullVel" class="member-name-link">_fullVel</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#_fullVel" class="member-name-link">_fullVel</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html#_lastTime" class="member-name-link">_lastTime</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html#_running" class="member-name-link">_running</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#_sensorPhase" class="member-name-link">_sensorPhase</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#_sensorPhase" class="member-name-link">_sensorPhase</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#_simProfiles" class="member-name-link">_simProfiles</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#_talon" class="member-name-link">_talon</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonFXSimProfile.html#_vel" class="member-name-link">_vel</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonFXSimProfile.html" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">The current velocity</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html#_vel" class="member-name-link">_vel</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/TalonSRXSimProfile.html" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">The current velocity</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html#_victor" class="member-name-link">_victor</a> - Variable in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/VictorSPXSimProfile.html" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
385
docs/index-files/index-3.html
Normal file
385
docs/index-files/index-3.html
Normal file
@@ -0,0 +1,385 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>C-Index</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-08-29">
|
||||
<meta name="description" content="index: C">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:C">C</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">calcMaxAccel(Rotation2d, List<Matter>, double, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)" class="member-name-link">calculateDegreesPerSteeringRotation(double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the degrees per steering rotation for the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calculateMaxAcceleration(double)" class="member-name-link">calculateMaxAcceleration(double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calculateMaxAcceleration(double,double,double,double,double)" class="member-name-link">calculateMaxAcceleration(double, double, double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the maximum theoretical acceleration without friction.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calculateMaxAngularVelocity(double,double,double)" class="member-name-link">calculateMaxAngularVelocity(double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the maximum angular velocity.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#calculateMetersPerRotation(double,double,double)" class="member-name-link">calculateMetersPerRotation(double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the meters per rotation for the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">CanAndCoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
||||
<dd>
|
||||
<div class="block">HELIUM <code>CANandcoder</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">CanAndCoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the <code>CANandcoder</code></div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#canbus" class="member-name-link">canbus</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The CAN bus name which the device resides on if using CAN.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">CANCoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">CANCoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Initialize the CANCoder on the standard CANBus.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#%3Cinit%3E(int,java.lang.String)" class="member-name-link">CANCoderSwerve(int, String)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Initialize the CANCoder on the CANivore.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#chassisVelocityCorrection" class="member-name-link">chassisVelocityCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Correct chassis velocity in <a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>SwerveDrive.drive(Translation2d, double, boolean, boolean)</code></a> using 254's
|
||||
correction.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#checkDirectory(java.io.File)" class="member-name-link">checkDirectory(File)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Check directory structure.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear sticky faults on IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#config" class="member-name-link">config</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block"><a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
|
||||
robot heading, and deadband for heading joystick.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configChanged" class="member-name-link">configChanged</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">If the TalonFX configuration has changed.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configChanged" class="member-name-link">configChanged</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">If the TalonFX configuration has changed.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Current TalonFX configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Current TalonFX configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve module configuration options.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the CANandCoder to read from [0, 360) per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configureCANStatusFrames(int)" class="member-name-link">configureCANStatusFrames(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the CAN status frames.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configureCANStatusFrames(int)" class="member-name-link">configureCANStatusFrames(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the CAN status frames.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configureCANStatusFrames(int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the CAN status frames.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configureCANStatusFrames(int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the CAN status frames.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configureCANStatusFrames(int,int,int,int,int,int,int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int, int, int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the CAN status frames.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configureCANStatusFrames(int,int,int,int,int,int,int,int,int,int,int)" class="member-name-link">configureCANStatusFrames(int, int, int, int, int, int, int, int, int, int, int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Set the CAN status frames.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the integrated encoder for the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the integrated encoder for the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the integrated encoder for the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the integrated encoder for the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the integrated encoder for the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PIDF values for the closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PIDF values for the closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PIDF values for the closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PIDF values for the closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PIDF values for the closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the PID wrapping for the position closed loop controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#controllerPropertiesJson" class="member-name-link">controllerPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Parsed controllerproperties.json</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">ControllerPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block"><a href="../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#%3Cinit%3E()" class="member-name-link">ControllerPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#convertToNativeSensorUnits(double,double)" class="member-name-link">convertToNativeSensorUnits(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Convert the setpoint into native sensor units.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#convertToNativeSensorUnits(double,double)" class="member-name-link">convertToNativeSensorUnits(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Convert the setpoint into native sensor units.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#createControllerConfiguration(swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">createControllerConfiguration(SwerveDriveConfiguration)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the <a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> based on parsed and given data.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#createDriveFeedforward()" class="member-name-link">createDriveFeedforward()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the drive feedforward for swerve modules.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#createEncoder(swervelib.motors.SwerveMotor)" class="member-name-link">createEncoder(SwerveMotor)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> from the current configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#createIMU()" class="member-name-link">createIMU()</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> from the given configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#createIntegratedEncoder(swervelib.motors.SwerveMotor)" class="member-name-link">createIntegratedEncoder(SwerveMotor)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> from the data port on the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,double,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">createModuleConfiguration(PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, String)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the swerve module configuration based off of parsed data.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#createModules(swervelib.parser.SwerveModuleConfiguration%5B%5D)" class="member-name-link">createModules(SwerveModuleConfiguration[])</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create modules based off of the SwerveModuleConfiguration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#createMotor(boolean)" class="member-name-link">createMotor(boolean)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> from the given configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#createPhysicalProperties(double)" class="member-name-link">createPhysicalProperties(double)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create the physical characteristics based off the parsed data.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#createPIDController()" class="member-name-link">createPIDController()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create a PIDController from the PID values.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#createSwerveDrive()" class="member-name-link">createSwerveDrive()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Create <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#currentLimit" class="member-name-link">currentLimit</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The current limit in AMPs to apply to the motors.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
152
docs/index-files/index-4.html
Normal file
152
docs/index-files/index-4.html
Normal file
@@ -0,0 +1,152 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>D-Index</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-08-29">
|
||||
<meta name="description" content="index: D">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:D">D</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#d" class="member-name-link">d</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Derivative Gain for PID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#desaturateWheelSpeeds(swervelib.math.SwerveModuleState2%5B%5D,double)" class="member-name-link">desaturateWheelSpeeds(SwerveModuleState2[], double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveKinematics2.html#desaturateWheelSpeeds(swervelib.math.SwerveModuleState2%5B%5D,edu.wpi.first.math.kinematics.ChassisSpeeds,double,double,double)" class="member-name-link">desaturateWheelSpeeds(SwerveModuleState2[], ChassisSpeeds, double, double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well as getting rid of
|
||||
joystick saturation at edges of joystick.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#desiredChassisSpeeds" class="member-name-link">desiredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">Describes the desired forward, sideways and angular velocity of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#desiredStates" class="member-name-link">desiredStates</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">An array of rotation and velocity values describing the desired state of each swerve module</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html" class="type-name-link" title="class in swervelib.parser.json">DeviceJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
||||
<dd>
|
||||
<div class="block">Device JSON parsed class.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#%3Cinit%3E()" class="member-name-link">DeviceJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#disableSecondOrderKinematics()" class="member-name-link">disableSecondOrderKinematics()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Disable second order kinematics.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor device configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/BoolMotorJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor inversion state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The PIDF with Integral Zone used for the drive motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)" class="member-name-link">drive(Translation2d, double, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">The primary method for controlling the drivebase.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean,boolean)" class="member-name-link">drive(Translation2d, double, boolean, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">The primary method for controlling the drivebase.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveEncoderPulsePerRotation" class="member-name-link">driveEncoderPulsePerRotation</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive motor encoder pulse per rotation.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveGearRatio" class="member-name-link">driveGearRatio</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Drive gear ratio.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorCurrentLimit" class="member-name-link">driveMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">Current limits for the Swerve Module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotorInverted" class="member-name-link">driveMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">State of inversion of the drive motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorRampRate" class="member-name-link">driveMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
||||
<dd>
|
||||
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#dt" class="member-name-link">dt</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Time delta since last update</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
107
docs/index-files/index-5.html
Normal file
107
docs/index-files/index-5.html
Normal file
@@ -0,0 +1,107 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>E-Index</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-08-29">
|
||||
<meta name="description" content="index: E">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:E">E</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/SwerveDrive.html#enableSecondOrderKinematics()" class="member-name-link">enableSecondOrderKinematics()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Enable second order kinematics for tracking purposes but completely untuned.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#enableSecondOrderKinematics(double)" class="member-name-link">enableSecondOrderKinematics(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Enable second order kinematics for simulation and modifying the feedforward.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#enableSecondOrderKinematics(int)" class="member-name-link">enableSecondOrderKinematics(int)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Enable second order kinematics with calculated values for the feedforward and return the value used.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Encoder as Analog Input.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">The <code>CANandcoder</code> representing the CANandCoder on the CAN bus.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">CANCoder with WPILib sendable and support.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Absolute encoder device configuration.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#encoderPulsePerRotation" class="member-name-link">encoderPulsePerRotation</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Encoder pulse per rotation for non-integrated encoders.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
177
docs/index-files/index-6.html
Normal file
177
docs/index-files/index-6.html
Normal file
@@ -0,0 +1,177 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>F-Index</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-08-29">
|
||||
<meta name="description" content="index: F">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:F">F</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#f" class="member-name-link">f</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Feedforward value for PID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset the encoder to factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset the encoder to factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset the encoder to factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset the encoder to factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset the encoder to factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Reset IMU to factory default.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Configure the factory defaults.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#fakePos" class="member-name-link">fakePos</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fake motor position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#fakeSpeed" class="member-name-link">fakeSpeed</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">The fake speed of the previous state, used to calculate <a href="../swervelib/simulation/SwerveModuleSimulation.html#fakePos"><code>SwerveModuleSimulation.fakePos</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#feedforward" class="member-name-link">feedforward</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Feedforward for drive motor during closed loop control.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#field" class="member-name-link">field</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Field object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#forwardDirection" class="member-name-link">forwardDirection</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">The direction the robot should be facing when the "Robot Rotation" is zero or blank.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#front" class="member-name-link">front</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Location of the swerve module in inches from the center of the robot horizontally.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
473
docs/index-files/index-7.html
Normal file
473
docs/index-files/index-7.html
Normal file
@@ -0,0 +1,473 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>G-Index</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-08-29">
|
||||
<meta name="description" content="index: G">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:G">G</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#gearRatio" class="member-name-link">gearRatio</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gear ratio for the motors, number of times the motor has to spin before the wheel rotates a single time.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the absolute position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in m/s/s.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets current acceleration of the robot in m/s/s.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getAngleMotor()" class="member-name-link">getAngleMotor()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the angle <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getConfiguration()" class="member-name-link">getConfiguration()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed configurations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getDriveMotor()" class="member-name-link">getDriveMotor()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the drive <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.html#getEstimatedPosition()" class="member-name-link">getEstimatedPosition()</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the estimated robot pose.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getFieldVelocity()" class="member-name-link">getFieldVelocity()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current field-relative velocity (x, y and omega) of the robot</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getGyroRotation3d()" class="member-name-link">getGyroRotation3d()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the estimated gyro <code>Rotation3d</code> of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getGyroRotation3d()" class="member-name-link">getGyroRotation3d()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current gyro <code>Rotation3d</code> of the robot, as reported by the imu.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the instantiated IMU object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.html#getInstance()" class="member-name-link">getInstance()</a> - Static method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.html" title="class in swervelib.simulation.ctre">PhysicsSim</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the robot simulator instance.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#getJoystickAngle(double,double)" class="member-name-link">getJoystickAngle(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the angle in radians based off of the heading joysticks.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveParser.html#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName(String, SwerveDriveConfiguration)</a> - Static method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the swerve module by the json name.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getModulePositions()" class="member-name-link">getModulePositions()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current module positions (azimuth and wheel position (meters)).</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getModules()" class="member-name-link">getModules()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>s associated with the <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the motor object from the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the motor object from the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the motor object from the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the motor object from the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the motor object from the module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html#getPeriod()" class="member-name-link">getPeriod()</a> - Method in class swervelib.simulation.ctre.<a href="../swervelib/simulation/ctre/PhysicsSim.SimProfile.html" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns the time since last call, in milliseconds.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getPitch()" class="member-name-link">getPitch()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Pitch is not simulated currently, always returns 0.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getPitch()" class="member-name-link">getPitch()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current pitch angle of the robot, as reported by the imu.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getPose()" class="member-name-link">getPose()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current pose (position and rotation) of the robot, as reported by odometry.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveDriveOdometry2.html#getPoseMeters()" class="member-name-link">getPoseMeters()</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Returns the position of the robot on the field.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the position of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the position of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the position of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the position of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the position of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the simulated swerve module position.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the position of the swerve module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#getPositionEncoderConversion(boolean)" class="member-name-link">getPositionEncoderConversion(boolean)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the encoder conversion for position encoders.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#getPulsePerRotation(int)" class="member-name-link">getPulsePerRotation(int)</a> - Method in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the encoder pulse per rotation based off of the encoder type.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU without any zeroing.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#getRawTargetSpeeds(double,double,double)" class="member-name-link">getRawTargetSpeeds(double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#getRawTargetSpeeds(double,double,double,double)" class="member-name-link">getRawTargetSpeeds(double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getRelativePosition()" class="member-name-link">getRelativePosition()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the relative angle in degrees.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getRobotVelocity()" class="member-name-link">getRobotVelocity()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current robot-relative velocity (x, y and omega) of the robot</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getRoll()" class="member-name-link">getRoll()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Roll is not simulated currently, always returns 0.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getRoll()" class="member-name-link">getRoll()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current roll angle of the robot, as reported by the imu.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/SwerveIMU.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></dt>
|
||||
<dd>
|
||||
<div class="block">Fetch the <code>Rotation3d</code> from the IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#getState()" class="member-name-link">getState()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the <a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> of the simulated module.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveModule.html#getState()" class="member-name-link">getState()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the Swerve Module state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getStates()" class="member-name-link">getStates()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current module states (azimuth and velocity)</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getSwerveController()" class="member-name-link">getSwerveController()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Helper function to get the <a href="../swervelib/SwerveDrive.html#swerveController"><code>SwerveDrive.swerveController</code></a> for the <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> which can be used to
|
||||
generate <code>ChassisSpeeds</code> for the robot to orient it correctly given axis or angles, and apply
|
||||
<code>SlewRateLimiter</code> to given inputs.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveMath.html#getSwerveModule(swervelib.SwerveModule%5B%5D,boolean,boolean)" class="member-name-link">getSwerveModule(SwerveModule[], boolean, boolean)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the fruthest module from center based on the module locations.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getSwerveModulePoses(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">getSwerveModulePoses(Pose2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the swerve module poses and on the field relative to the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, double, double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#getTranslation2d(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">getTranslation2d(ChassisSpeeds)</a> - Static method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Helper function to get the <code>Translation2d</code> of the chassis speeds given the <code>ChassisSpeeds</code>.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the velocity of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the velocity of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the velocity of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the velocity of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the velocity of the integrated encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
||||
<dd>
|
||||
<div class="block">Get the estimated angle of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Gyroscope object.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/NavXSwerve.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">NavX IMU.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#gyroAngle" class="member-name-link">gyroAngle</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#gyroPitch" class="member-name-link">gyroPitch</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#gyroRoll" class="member-name-link">gyroRoll</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
79
docs/index-files/index-8.html
Normal file
79
docs/index-files/index-8.html
Normal file
@@ -0,0 +1,79 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>H-Index</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-08-29">
|
||||
<meta name="description" content="index: H">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:H">H</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#hashCode()" class="member-name-link">hashCode()</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd> </dd>
|
||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#heading" class="member-name-link">heading</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The PID used to control the robot heading.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveController.html#headingCalculate(double,double)" class="member-name-link">headingCalculate(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
||||
<dd>
|
||||
<div class="block">Calculate the angular velocity given the current and target heading angle in radians.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#headingPIDF" class="member-name-link">headingPIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">PIDF for the heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#HIGH" class="member-name-link">HIGH</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
||||
<dd>
|
||||
<div class="block">Full swerve drive data is sent back in both human and machine readable forms.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
169
docs/index-files/index-9.html
Normal file
169
docs/index-files/index-9.html
Normal file
@@ -0,0 +1,169 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>I-Index</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-08-29">
|
||||
<meta name="description" content="index: I">
|
||||
<meta name="generator" content="javadoc/IndexWriter">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="index-page">
|
||||
<script type="text/javascript">var pathtoroot = "../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../index.html">Overview</a></li>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="../overview-tree.html">Tree</a></li>
|
||||
<li class="nav-bar-cell1-rev">Index</li>
|
||||
<li><a href="../help-doc.html#index">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1>Index</h1>
|
||||
</div>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
||||
<h2 class="title" id="I:I">I</h2>
|
||||
<dl class="index">
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#i" class="member-name-link">i</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Integral Gain for PID.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#id" class="member-name-link">id</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">The CAN ID or pin ID of the device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Pigeon2 IMU device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Pigeon v1 IMU device.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Robot IMU used to determine heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve IMU</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#interpolate(swervelib.math.SwervePoseEstimator2.InterpolationRecord,double)" class="member-name-link">interpolate(SwervePoseEstimator2.InterpolationRecord, double)</a> - Method in class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd>
|
||||
<div class="block">Return the interpolated record.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html#%3Cinit%3E(edu.wpi.first.math.geometry.Pose2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D)" class="member-name-link">InterpolationRecord(Pose2d, Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[])</a> - Constructor for class swervelib.math.<a href="../swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></dt>
|
||||
<dd>
|
||||
<div class="block">Constructs an Interpolation Record with the specified parameters.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/math/SwerveModuleState2.html#invert()" class="member-name-link">invert()</a> - Method in class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
|
||||
<dd>
|
||||
<div class="block">Invert the swerve module state.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Inversion state of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/encoders/CanAndCoderSwerve.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CanAndCoderSwerve.html" title="class in swervelib.encoders">CanAndCoderSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Inversion state of the encoder.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Defines which motors are inverted.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
||||
<dd>
|
||||
<div class="block">Invert the IMU of the robot.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
||||
<dd>
|
||||
<div class="block">Invert the imu measurements.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/SwerveDrive.html#invertOdometry" class="member-name-link">invertOdometry</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
||||
<dd>
|
||||
<div class="block">Invert odometry readings of drive motor positions, used as a patch for debugging currently.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
||||
<dd>
|
||||
<div class="block">Queries whether the absolute encoder is directly attached to the motor controller.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/motors/SwerveMotor.html#isDriveMotor" class="member-name-link">isDriveMotor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
||||
<dd>
|
||||
<div class="block">Whether the swerve motor is a drive motor.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#isSimulation" class="member-name-link">isSimulation</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
||||
<dd>
|
||||
<div class="block">State of simulation of the Robot, used to optimize retrieval.</div>
|
||||
</dd>
|
||||
<dt><a href="../swervelib/parser/PIDFConfig.html#iz" class="member-name-link">iz</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
||||
<dd>
|
||||
<div class="block">Integral zone of the PID.</div>
|
||||
</dd>
|
||||
</dl>
|
||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <a href="index-26.html">_</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Overview (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Overview</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-08-29">
|
||||
<meta name="description" content="package index">
|
||||
<meta name="generator" content="javadoc/PackageIndexWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-index-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="overview-tree.html">Tree</a></li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="index-files/index-1.html">Index</a></li>
|
||||
<li><a href="help-doc.html#overview">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -46,9 +47,6 @@ loadScripts(document, 'script');</script>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<div class="header">
|
||||
<h1 class="title">YAGSL-Lib API</h1>
|
||||
</div>
|
||||
<div id="all-packages-table">
|
||||
<div class="caption"><span>Packages</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
|
||||
3
docs/jquery-ui.overrides.css
vendored
3
docs/jquery-ui.overrides.css
vendored
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
|
||||
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
|
||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
||||
*
|
||||
* This code is free software; you can redistribute it and/or modify it
|
||||
@@ -31,5 +31,4 @@ a.ui-button:active,
|
||||
.ui-button.ui-state-active:hover {
|
||||
/* Overrides the color of selection used in jQuery UI */
|
||||
background: #F8981D;
|
||||
border: 1px solid #F8981D;
|
||||
}
|
||||
|
||||
1
docs/legal/ADDITIONAL_LICENSE_INFO
Normal file
1
docs/legal/ADDITIONAL_LICENSE_INFO
Normal file
@@ -0,0 +1 @@
|
||||
Please see ..\java.base\ADDITIONAL_LICENSE_INFO
|
||||
@@ -1,27 +1 @@
|
||||
|
||||
OPENJDK ASSEMBLY EXCEPTION
|
||||
|
||||
The OpenJDK source code made available by Oracle America, Inc. (Oracle) at
|
||||
openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU
|
||||
General Public License <http://www.gnu.org/copyleft/gpl.html> version 2
|
||||
only ("GPL2"), with the following clarification and special exception.
|
||||
|
||||
Linking this OpenJDK Code statically or dynamically with other code
|
||||
is making a combined work based on this library. Thus, the terms
|
||||
and conditions of GPL2 cover the whole combination.
|
||||
|
||||
As a special exception, Oracle gives you permission to link this
|
||||
OpenJDK Code with certain code licensed by Oracle as indicated at
|
||||
http://openjdk.java.net/legal/exception-modules-2007-05-08.html
|
||||
("Designated Exception Modules") to produce an executable,
|
||||
regardless of the license terms of the Designated Exception Modules,
|
||||
and to copy and distribute the resulting executable under GPL2,
|
||||
provided that the Designated Exception Modules continue to be
|
||||
governed by the licenses under which they were offered by Oracle.
|
||||
|
||||
As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code
|
||||
to build an executable that includes those portions of necessary code that
|
||||
Oracle could not provide under GPL2 (or that Oracle has provided under GPL2
|
||||
with the Classpath exception). If you modify or add to the OpenJDK code,
|
||||
that new GPL2 code may still be combined with Designated Exception Modules
|
||||
if the new code is made subject to this exception by its copyright holder.
|
||||
Please see ..\java.base\ASSEMBLY_EXCEPTION
|
||||
|
||||
1
docs/legal/LICENSE
Normal file
1
docs/legal/LICENSE
Normal file
@@ -0,0 +1 @@
|
||||
Please see ..\java.base\LICENSE
|
||||
@@ -1,9 +1,9 @@
|
||||
## jQuery v3.6.1
|
||||
## jQuery v3.5.1
|
||||
|
||||
### jQuery License
|
||||
```
|
||||
jQuery v 3.6.1
|
||||
Copyright OpenJS Foundation and other contributors, https://openjsf.org/
|
||||
jQuery v 3.5.1
|
||||
Copyright JS Foundation and other contributors, https://js.foundation/
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
@@ -26,7 +26,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
******************************************
|
||||
|
||||
The jQuery JavaScript Library v3.6.1 also includes Sizzle.js
|
||||
The jQuery JavaScript Library v3.5.1 also includes Sizzle.js
|
||||
|
||||
Sizzle.js includes the following license:
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,10 +1,11 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>YAGSL-Lib API</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Generated Documentation (Untitled)</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-08-29">
|
||||
<meta name="description" content="index redirect">
|
||||
<meta name="generator" content="javadoc/IndexRedirectWriter">
|
||||
<link rel="canonical" href="index.html">
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Class Hierarchy (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Class Hierarchy</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-08-29">
|
||||
<meta name="description" content="class tree">
|
||||
<meta name="generator" content="javadoc/TreeWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="tree-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li>Package</li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="index-all.html">Index</a></li>
|
||||
<li><a href="index-files/index-1.html">Index</a></li>
|
||||
<li><a href="help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -75,17 +76,17 @@ loadScripts(document, 'script');</script>
|
||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a></li>
|
||||
<li class="circle">swervelib.math.<a href="swervelib/math/Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a></li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.Odometry<T>
|
||||
<ul>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveOdometry
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveDriveOdometry2.html" class="type-name-link" title="class in swervelib.math">SwerveDriveOdometry2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigInt.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigInt</a></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PhysicalPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="swervelib/simulation/ctre/PhysicsSim.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="swervelib/simulation/ctre/PhysicsSim.SimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">PhysicsSim.SimProfile</a>
|
||||
<ul>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="swervelib/simulation/ctre/TalonFXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">TalonFXSimProfile</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="swervelib/simulation/ctre/TalonSRXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">TalonSRXSimProfile</a></li>
|
||||
<li class="circle">swervelib.simulation.ctre.<a href="swervelib/simulation/ctre/VictorSPXSimProfile.html" class="type-name-link" title="class in swervelib.simulation.ctre">VictorSPXSimProfile</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a></li>
|
||||
<li class="circle">swervelib.parser.deserializer.<a href="swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a></li>
|
||||
@@ -102,11 +103,16 @@ loadScripts(document, 'script');</script>
|
||||
<li class="circle">swervelib.<a href="swervelib/SwerveDrive.html" class="type-name-link" title="class in swervelib">SwerveDrive</a></li>
|
||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveDriveConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveDriveConfiguration</a></li>
|
||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/SwerveDriveJson.html" class="type-name-link" title="class in swervelib.parser.json">SwerveDriveJson</a></li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveKinematics (implements edu.wpi.first.math.kinematics.Kinematics<S,<wbr>P>)
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveKinematics
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveKinematics2.html" class="type-name-link" title="class in swervelib.math">SwerveKinematics2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveOdometry
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveDriveOdometry2.html" class="type-name-link" title="class in swervelib.math">SwerveDriveOdometry2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/SwerveDriveTelemetry.html" class="type-name-link" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></li>
|
||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/SwerveIMU.html" class="type-name-link" title="class in swervelib.imu">SwerveIMU</a>
|
||||
<ul>
|
||||
@@ -140,6 +146,7 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveParser.html" class="type-name-link" title="class in swervelib.parser">SwerveParser</a></li>
|
||||
<li class="circle">swervelib.math.<a href="swervelib/math/SwervePoseEstimator2.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2</a></li>
|
||||
<li class="circle">swervelib.math.<a href="swervelib/math/SwervePoseEstimator2.InterpolationRecord.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a> (implements edu.wpi.first.math.interpolation.Interpolatable<T>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -151,6 +158,7 @@ loadScripts(document, 'script');</script>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
||||
<ul>
|
||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></li>
|
||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" class="type-name-link" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
BIN
docs/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png
Normal file
BIN
docs/script-dir/images/ui-bg_glass_55_fbf9ee_1x400.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 335 B |
BIN
docs/script-dir/images/ui-bg_glass_65_dadada_1x400.png
Normal file
BIN
docs/script-dir/images/ui-bg_glass_65_dadada_1x400.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
BIN
docs/script-dir/images/ui-bg_glass_75_dadada_1x400.png
Normal file
BIN
docs/script-dir/images/ui-bg_glass_75_dadada_1x400.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
BIN
docs/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png
Normal file
BIN
docs/script-dir/images/ui-bg_glass_75_e6e6e6_1x400.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
BIN
docs/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png
Normal file
BIN
docs/script-dir/images/ui-bg_glass_95_fef1ec_1x400.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 332 B |
BIN
docs/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png
Normal file
BIN
docs/script-dir/images/ui-bg_highlight-soft_75_cccccc_1x100.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 280 B |
BIN
docs/script-dir/images/ui-icons_222222_256x240.png
Normal file
BIN
docs/script-dir/images/ui-icons_222222_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
docs/script-dir/images/ui-icons_2e83ff_256x240.png
Normal file
BIN
docs/script-dir/images/ui-icons_2e83ff_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
BIN
docs/script-dir/images/ui-icons_454545_256x240.png
Normal file
BIN
docs/script-dir/images/ui-icons_454545_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
docs/script-dir/images/ui-icons_888888_256x240.png
Normal file
BIN
docs/script-dir/images/ui-icons_888888_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
BIN
docs/script-dir/images/ui-icons_cd0a0a_256x240.png
Normal file
BIN
docs/script-dir/images/ui-icons_cd0a0a_256x240.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 4.4 KiB |
2
docs/script-dir/jquery-3.5.1.min.js
vendored
Normal file
2
docs/script-dir/jquery-3.5.1.min.js
vendored
Normal file
File diff suppressed because one or more lines are too long
7
docs/script-dir/jquery-ui.min.css
vendored
7
docs/script-dir/jquery-ui.min.css
vendored
File diff suppressed because one or more lines are too long
4
docs/script-dir/jquery-ui.min.js
vendored
4
docs/script-dir/jquery-ui.min.js
vendored
File diff suppressed because one or more lines are too long
5
docs/script-dir/jquery-ui.structure.min.css
vendored
Normal file
5
docs/script-dir/jquery-ui.structure.min.css
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
/*! jQuery UI - v1.12.1 - 2018-12-06
|
||||
* http://jqueryui.com
|
||||
* Copyright jQuery Foundation and other contributors; Licensed MIT */
|
||||
|
||||
.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;filter:Alpha(Opacity=0)}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0}
|
||||
@@ -611,7 +611,6 @@ main, nav, header, footer, section {
|
||||
ul.ui-autocomplete {
|
||||
position:fixed;
|
||||
z-index:999999;
|
||||
background-color: #FFFFFF;
|
||||
}
|
||||
ul.ui-autocomplete li {
|
||||
float:left;
|
||||
@@ -621,9 +620,6 @@ ul.ui-autocomplete li {
|
||||
.result-highlight {
|
||||
font-weight:bold;
|
||||
}
|
||||
.ui-autocomplete .result-item {
|
||||
font-size: inherit;
|
||||
}
|
||||
#search-input {
|
||||
background-image:url('resources/glass.png');
|
||||
background-size:13px;
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveController (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 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-08-29">
|
||||
<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">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -98,8 +99,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#config" class="member-name-link">config</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code>
|
||||
for controlling the robot heading, and deadband for heading joystick.</div>
|
||||
<div class="block"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
|
||||
robot heading, and deadband for heading joystick.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#lastAngleScalar" class="member-name-link">lastAngleScalar</a></code></div>
|
||||
@@ -134,8 +135,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.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveController</a><wbr>(<a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> cfg)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot
|
||||
based on controller input.</div>
|
||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot based on controller
|
||||
input.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -169,8 +170,7 @@ loadScripts(document, 'script');</script>
|
||||
double ySpeed,
|
||||
double omega)</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 <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in
|
||||
radians.</div>
|
||||
<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 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="#getRawTargetSpeeds(double,double,double,double)" class="member-name-link">getRawTargetSpeeds</a><wbr>(double xSpeed,
|
||||
@@ -178,8 +178,7 @@ loadScripts(document, 'script');</script>
|
||||
double targetHeadingAngleRadians,
|
||||
double currentHeadingAngleRadians)</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 <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in
|
||||
radians.</div>
|
||||
<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 xInput,
|
||||
@@ -241,8 +240,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="config">
|
||||
<h3>config</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></span> <span class="element-name">config</span></div>
|
||||
<div class="block"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code>
|
||||
for controlling the robot heading, and deadband for heading joystick.</div>
|
||||
<div class="block"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
|
||||
robot heading, and deadband for heading joystick.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
@@ -292,12 +291,11 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="<init>(swervelib.parser.SwerveControllerConfiguration)">
|
||||
<h3>SwerveController</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveController</span><wbr><span class="parameters">(<a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> cfg)</span></div>
|
||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot
|
||||
based on controller input.</div>
|
||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot based on controller
|
||||
input.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>cfg</code> - <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> containing the PIDF variables for the heading
|
||||
PIDF.</dd>
|
||||
<dd><code>cfg</code> - <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> containing the PIDF variables for the heading PIDF.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -328,8 +326,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSlewRateLimiters</span><wbr><span class="parameters">(edu.wpi.first.math.filter.SlewRateLimiter x,
|
||||
edu.wpi.first.math.filter.SlewRateLimiter y,
|
||||
edu.wpi.first.math.filter.SlewRateLimiter angle)</span></div>
|
||||
<div class="block">Add slew rate limiters to all controls. This prevents the robot from ramping up too much. To
|
||||
disable a <code>SlewRateLimiter</code> set the desired one to null.</div>
|
||||
<div class="block">Add slew rate limiters to all controls. This prevents the robot from ramping up too much. To disable a
|
||||
<code>SlewRateLimiter</code> set the desired one to null.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>x</code> - The <code>SlewRateLimiter</code> for the X velocity in meters/second.</dd>
|
||||
@@ -349,7 +347,8 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>x</code> - The x value for the joystick in which the deadband should be applied.</dd>
|
||||
<dd><code>y</code> - The y value for the joystick in which the deadband should be applied.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>Whether the values are within the deadband from <a href="parser/SwerveControllerConfiguration.html#angleJoyStickRadiusDeadband"><code>SwerveControllerConfiguration.angleJoyStickRadiusDeadband</code></a>.</dd>
|
||||
<dd>Whether the values are within the deadband from
|
||||
<a href="parser/SwerveControllerConfiguration.html#angleJoyStickRadiusDeadband"><code>SwerveControllerConfiguration.angleJoyStickRadiusDeadband</code></a>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -395,8 +394,8 @@ loadScripts(document, 'script');</script>
|
||||
double headingX,
|
||||
double headingY,
|
||||
double currentHeadingAngleRadians)</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>
|
||||
<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">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction.</dd>
|
||||
@@ -415,8 +414,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getRawTargetSpeeds</span><wbr><span class="parameters">(double xSpeed,
|
||||
double ySpeed,
|
||||
double omega)</span></div>
|
||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in
|
||||
radians.</div>
|
||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>xSpeed</code> - X speed in meters per second.</dd>
|
||||
@@ -434,8 +432,7 @@ loadScripts(document, 'script');</script>
|
||||
double ySpeed,
|
||||
double targetHeadingAngleRadians,
|
||||
double currentHeadingAngleRadians)</span></div>
|
||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in
|
||||
radians.</div>
|
||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>xSpeed</code> - X speed in meters per second.</dd>
|
||||
@@ -467,7 +464,8 @@ loadScripts(document, 'script');</script>
|
||||
<h3>setMaximumAngularVelocity</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaximumAngularVelocity</span><wbr><span class="parameters">(double angularVelocity)</span></div>
|
||||
<div class="block">Set a new maximum angular velocity that is different from the auto-generated one. Modified the
|
||||
<a href="parser/SwerveControllerConfiguration.html#maxAngularVelocity"><code>SwerveControllerConfiguration.maxAngularVelocity</code></a> field which is used in the <a href="SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> class for <code>ChassisSpeeds</code> generation.</div>
|
||||
<a href="parser/SwerveControllerConfiguration.html#maxAngularVelocity"><code>SwerveControllerConfiguration.maxAngularVelocity</code></a> field which is used in the <a href="SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> class
|
||||
for <code>ChassisSpeeds</code> generation.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>angularVelocity</code> - Angular velocity in radians per second.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveDrive (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveDrive</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib, class: SwerveDrive">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -93,29 +94,49 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#chassisVelocityCorrection" class="member-name-link">chassisVelocityCorrection</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Correct chassis velocity in <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(Translation2d, double, boolean, boolean)</code></a>
|
||||
using 254's correction.</div>
|
||||
<div class="block">Correct chassis velocity in <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(Translation2d, double, boolean, boolean)</code></a> using 254's
|
||||
correction.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>edu.wpi.first.wpilibj.smartdashboard.Field2d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#field" class="member-name-link">field</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Field object.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#invertOdometry" class="member-name-link">invertOdometry</a></code></div>
|
||||
<div class="col-first even-row-color"><code>private <a href="imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#invertOdometry" class="member-name-link">invertOdometry</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Invert odometry readings of drive motor positions, used as a patch for debugging currently.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>final <a href="math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#kinematics" class="member-name-link">kinematics</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>final <a href="math/SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#kinematics" class="member-name-link">kinematics</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve Kinematics object utilizing second order kinematics.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">The last heading set in radians.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#simIMU" class="member-name-link">simIMU</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Simulation of the swerve drive.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#stateStdDevs" class="member-name-link">stateStdDevs</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Trustworthiness of the internal model of how motors should be moving Measured in expected
|
||||
standard deviation (meters of position and degrees of rotation)</div>
|
||||
<div class="block">Trustworthiness of the internal model of how motors should be moving Measured in expected standard deviation
|
||||
(meters of position and degrees of rotation)</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#swerveController" class="member-name-link">swerveController</a></code></div>
|
||||
@@ -132,11 +153,16 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve odometry.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a></code></div>
|
||||
<div class="col-first even-row-color"><code>private final <a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#swerveModules" class="member-name-link">swerveModules</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Trustworthiness of the vision system Measured in expected standard deviation (meters of
|
||||
position and degrees of rotation)</div>
|
||||
<div class="block">Swerve modules.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#visionMeasurementStdDevs" class="member-name-link">visionMeasurementStdDevs</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Trustworthiness of the vision system Measured in expected standard deviation (meters of position and degrees of
|
||||
rotation)</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -174,7 +200,8 @@ loadScripts(document, 'script');</script>
|
||||
boolean soft,
|
||||
double trustWorthiness)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with the given timestamp of the vision measurement.</div>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
|
||||
the given timestamp of the vision measurement.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double,boolean,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement</a><wbr>(edu.wpi.first.math.geometry.Pose2d robotPose,
|
||||
@@ -182,7 +209,8 @@ loadScripts(document, 'script');</script>
|
||||
boolean soft,
|
||||
edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1> visionMeasurementStdDevs)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with the given timestamp of the vision measurement.</div>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
|
||||
the given timestamp of the vision measurement.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disableSecondOrderKinematics()" class="member-name-link">disableSecondOrderKinematics</a>()</code></div>
|
||||
@@ -219,8 +247,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#enableSecondOrderKinematics(int)" class="member-name-link">enableSecondOrderKinematics</a><wbr>(int motorFreeSpeedRPM)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Enable second order kinematics with calculated values for the feedforward and return the value
|
||||
used.</div>
|
||||
<div class="block">Enable second order kinematics with calculated values for the feedforward and return the value used.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAccel()" class="member-name-link">getAccel</a>()</code></div>
|
||||
@@ -275,9 +302,9 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveController()" class="member-name-link">getSwerveController</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Helper function to get the <a href="#swerveController"><code>swerveController</code></a> for the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>
|
||||
which can be used to generate <code>ChassisSpeeds</code> for the robot to orient it correctly given
|
||||
axis or angles, and apply <code>SlewRateLimiter</code> to given inputs.</div>
|
||||
<div class="block">Helper function to get the <a href="#swerveController"><code>swerveController</code></a> for the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> which can be used to
|
||||
generate <code>ChassisSpeeds</code> for the robot to orient it correctly given axis or angles, and apply
|
||||
<code>SlewRateLimiter</code> to given inputs.</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.geometry.Pose2d[]</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveModulePoses(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">getSwerveModulePoses</a><wbr>(edu.wpi.first.math.geometry.Pose2d robotPose)</code></div>
|
||||
@@ -307,8 +334,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetEncoders()" class="member-name-link">resetEncoders</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a
|
||||
reboot, like in autonomous.</div>
|
||||
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a reboot, like in
|
||||
autonomous.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetOdometry(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetOdometry</a><wbr>(edu.wpi.first.math.geometry.Pose2d pose)</code></div>
|
||||
@@ -333,16 +360,18 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double)" class="member-name-link">setMaximumSpeed</a><wbr>(double maximumSpeed)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and <a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is
|
||||
used for the <code>setRawModuleStates(SwerveModuleState2[], boolean)</code> function and
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
|
||||
<a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
|
||||
<a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState2[], boolean)</code></a> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumSpeed(double,boolean)" class="member-name-link">setMaximumSpeed</a><wbr>(double maximumSpeed,
|
||||
boolean updateModuleFeedforward)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and <a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is
|
||||
used for the <code>setRawModuleStates(SwerveModuleState2[], boolean)</code> function and
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
|
||||
<a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
|
||||
<a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState2[], boolean)</code></a> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
@@ -355,8 +384,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setModuleStateOptimization(boolean)" class="member-name-link">setModuleStateOptimization</a><wbr>(boolean optimizationEnabled)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Configure whether the <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> will be optimized to prevent spinning more
|
||||
than 90deg.</div>
|
||||
<div class="block">Configure whether the <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> will be optimized to prevent spinning more than 90deg.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)" class="member-name-link">setModuleStates</a><wbr>(<a href="math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[] desiredStates,
|
||||
@@ -369,19 +397,25 @@ 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">Sets the drive motors to brake/coast mode.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders</a>()</code></div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)" class="member-name-link">setRawModuleStates</a><wbr>(<a href="math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[] desiredStates,
|
||||
boolean isOpenLoop)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
|
||||
<div class="block">Set the module states (azimuth and velocity) directly.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateOdometry()" class="member-name-link">updateOdometry</a>()</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update odometry should be run every loop.</div>
|
||||
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zeroGyro()" class="member-name-link">zeroGyro</a>()</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateOdometry()" class="member-name-link">updateOdometry</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Update odometry should be run every loop.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zeroGyro()" class="member-name-link">zeroGyro</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -423,6 +457,13 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="swerveModules">
|
||||
<h3>swerveModules</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="SwerveModule.html" title="class in swervelib">SwerveModule</a>[]</span> <span class="element-name">swerveModules</span></div>
|
||||
<div class="block">Swerve modules.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="field">
|
||||
<h3>field</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.wpilibj.smartdashboard.Field2d</span> <span class="element-name">field</span></div>
|
||||
@@ -440,16 +481,16 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="stateStdDevs">
|
||||
<h3>stateStdDevs</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></span> <span class="element-name">stateStdDevs</span></div>
|
||||
<div class="block">Trustworthiness of the internal model of how motors should be moving Measured in expected
|
||||
standard deviation (meters of position and degrees of rotation)</div>
|
||||
<div class="block">Trustworthiness of the internal model of how motors should be moving Measured in expected standard deviation
|
||||
(meters of position and degrees of rotation)</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="visionMeasurementStdDevs">
|
||||
<h3>visionMeasurementStdDevs</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></span> <span class="element-name">visionMeasurementStdDevs</span></div>
|
||||
<div class="block">Trustworthiness of the vision system Measured in expected standard deviation (meters of
|
||||
position and degrees of rotation)</div>
|
||||
<div class="block">Trustworthiness of the vision system Measured in expected standard deviation (meters of position and degrees of
|
||||
rotation)</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
@@ -463,8 +504,36 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="chassisVelocityCorrection">
|
||||
<h3>chassisVelocityCorrection</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">chassisVelocityCorrection</span></div>
|
||||
<div class="block">Correct chassis velocity in <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(Translation2d, double, boolean, boolean)</code></a>
|
||||
using 254's correction.</div>
|
||||
<div class="block">Correct chassis velocity in <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(Translation2d, double, boolean, boolean)</code></a> using 254's
|
||||
correction.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></span> <span class="element-name">imu</span></div>
|
||||
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="simIMU">
|
||||
<h3>simIMU</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></span> <span class="element-name">simIMU</span></div>
|
||||
<div class="block">Simulation of the swerve drive.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="moduleSynchronizationCounter">
|
||||
<h3>moduleSynchronizationCounter</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name">moduleSynchronizationCounter</span></div>
|
||||
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="lastHeadingRadians">
|
||||
<h3>lastHeadingRadians</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">lastHeadingRadians</span></div>
|
||||
<div class="block">The last heading set in radians.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -480,18 +549,16 @@ loadScripts(document, 'script');</script>
|
||||
<h3>SwerveDrive</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveDrive</span><wbr><span class="parameters">(<a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> config,
|
||||
<a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> controllerConfig)</span></div>
|
||||
<div class="block">Creates a new swerve drivebase subsystem. Robot is controlled via the <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(edu.wpi.first.math.geometry.Translation2d, double, boolean, boolean)</code></a>
|
||||
method, or via the <code>setRawModuleStates(swervelib.math.SwerveModuleState2[], boolean)</code> method. The <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(edu.wpi.first.math.geometry.Translation2d, double, boolean, boolean)</code></a>
|
||||
method incorporates kinematics-- it takes a translation and rotation, as well as parameters for
|
||||
field-centric and closed-loop velocity control. <code>setRawModuleStates(swervelib.math.SwerveModuleState2[], boolean)</code> takes a
|
||||
list of SwerveModuleStates and directly passes them to the modules. This subsystem also handles
|
||||
odometry.</div>
|
||||
<div class="block">Creates a new swerve drivebase subsystem. Robot is controlled via the <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(edu.wpi.first.math.geometry.Translation2d, double, boolean, boolean)</code></a> method, or via the
|
||||
<a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>setRawModuleStates(swervelib.math.SwerveModuleState2[], boolean)</code></a> method. The <a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>drive(edu.wpi.first.math.geometry.Translation2d, double, boolean, boolean)</code></a> method incorporates kinematics-- it
|
||||
takes a translation and rotation, as well as parameters for field-centric and closed-loop velocity control.
|
||||
<a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>setRawModuleStates(swervelib.math.SwerveModuleState2[], boolean)</code></a> takes a list of SwerveModuleStates and directly passes them to the modules.
|
||||
This subsystem also handles odometry.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>config</code> - The <a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser"><code>SwerveDriveConfiguration</code></a> configuration to base the swerve drive off
|
||||
of.</dd>
|
||||
<dd><code>config</code> - The <a href="parser/SwerveDriveConfiguration.html" title="class in swervelib.parser"><code>SwerveDriveConfiguration</code></a> configuration to base the swerve drive off of.</dd>
|
||||
<dd><code>controllerConfig</code> - The <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> to use when creating the
|
||||
<a href="SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</dd>
|
||||
<a href="SwerveController.html" title="class in swervelib"><code>SwerveController</code></a>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -510,22 +577,21 @@ loadScripts(document, 'script');</script>
|
||||
double rotation,
|
||||
boolean fieldRelative,
|
||||
boolean isOpenLoop)</span></div>
|
||||
<div class="block">The primary method for controlling the drivebase. Takes a Translation2d and a rotation rate,
|
||||
and calculates and commands module states accordingly. Can use either open-loop or closed-loop
|
||||
velocity control for the wheel velocities. Also has field- and robot-relative modes, which
|
||||
affect how the translation vector is used. This method defaults to no heading correction.</div>
|
||||
<div class="block">The primary method for controlling the drivebase. Takes a Translation2d and a rotation rate, and calculates and
|
||||
commands module states accordingly. Can use either open-loop or closed-loop velocity control for the wheel
|
||||
velocities. Also has field- and robot-relative modes, which affect how the translation vector is used. This method
|
||||
defaults to no heading correction.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>translation</code> - <code>Translation2d</code> that is the commanded linear velocity of the robot, in
|
||||
meters per second. In robot-relative mode, positive x is torwards the bow (front) and
|
||||
positive y is torwards port (left). In field-relative mode, positive x is away from the
|
||||
alliance wall (field North) and positive y is torwards the left wall when looking through
|
||||
the driver station glass (field West).</dd>
|
||||
<dd><code>rotation</code> - Robot angular rate, in radians per second. CCW positive. Unaffected by
|
||||
field/robot relativity.</dd>
|
||||
<dd><code>translation</code> - <code>Translation2d</code> that is the commanded linear velocity of the robot, in meters per
|
||||
second. In robot-relative mode, positive x is torwards the bow (front) and positive y is
|
||||
torwards port (left). In field-relative mode, positive x is away from the alliance wall (field
|
||||
North) and positive y is torwards the left wall when looking through the driver station glass
|
||||
(field West).</dd>
|
||||
<dd><code>rotation</code> - Robot angular rate, in radians per second. CCW positive. Unaffected by field/robot
|
||||
relativity.</dd>
|
||||
<dd><code>fieldRelative</code> - Drive mode. True for field-relative, false for robot-relative.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable
|
||||
closed-loop.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable closed-loop.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -537,24 +603,21 @@ loadScripts(document, 'script');</script>
|
||||
boolean fieldRelative,
|
||||
boolean isOpenLoop,
|
||||
boolean headingCorrection)</span></div>
|
||||
<div class="block">The primary method for controlling the drivebase. Takes a Translation2d and a rotation rate,
|
||||
and calculates and commands module states accordingly. Can use either open-loop or closed-loop
|
||||
velocity control for the wheel velocities. Also has field- and robot-relative modes, which
|
||||
affect how the translation vector is used.</div>
|
||||
<div class="block">The primary method for controlling the drivebase. Takes a Translation2d and a rotation rate, and calculates and
|
||||
commands module states accordingly. Can use either open-loop or closed-loop velocity control for the wheel
|
||||
velocities. Also has field- and robot-relative modes, which affect how the translation vector is used.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>translation</code> - <code>Translation2d</code> that is the commanded linear velocity of the robot, in
|
||||
meters per second. In robot-relative mode, positive x is torwards the bow (front) and
|
||||
positive y is torwards port (left). In field-relative mode, positive x is away from the
|
||||
alliance wall (field North) and positive y is torwards the left wall when looking through
|
||||
the driver station glass (field West).</dd>
|
||||
<dd><code>rotation</code> - Robot angular rate, in radians per second. CCW positive. Unaffected by
|
||||
field/robot relativity.</dd>
|
||||
<dd><code>translation</code> - <code>Translation2d</code> that is the commanded linear velocity of the robot, in meters per
|
||||
second. In robot-relative mode, positive x is torwards the bow (front) and positive y is
|
||||
torwards port (left). In field-relative mode, positive x is away from the alliance wall
|
||||
(field North) and positive y is torwards the left wall when looking through the driver
|
||||
station glass (field West).</dd>
|
||||
<dd><code>rotation</code> - Robot angular rate, in radians per second. CCW positive. Unaffected by field/robot
|
||||
relativity.</dd>
|
||||
<dd><code>fieldRelative</code> - Drive mode. True for field-relative, false for robot-relative.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable
|
||||
closed-loop.</dd>
|
||||
<dd><code>headingCorrection</code> - Whether to correct heading when driving translationally. Set to true
|
||||
to enable.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable closed-loop.</dd>
|
||||
<dd><code>headingCorrection</code> - Whether to correct heading when driving translationally. Set to true to enable.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -567,12 +630,25 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Set the maximum speeds for desaturation.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>attainableMaxModuleSpeedMetersPerSecond</code> - The absolute max speed that a module can reach
|
||||
in meters per second.</dd>
|
||||
<dd><code>attainableMaxTranslationalSpeedMetersPerSecond</code> - The absolute max speed that your robot
|
||||
can reach while translating in meters per second.</dd>
|
||||
<dd><code>attainableMaxRotationalVelocityRadiansPerSecond</code> - The absolute max speed the robot can
|
||||
reach while rotating in radians per second.</dd>
|
||||
<dd><code>attainableMaxModuleSpeedMetersPerSecond</code> - The absolute max speed that a module can reach in meters per
|
||||
second.</dd>
|
||||
<dd><code>attainableMaxTranslationalSpeedMetersPerSecond</code> - The absolute max speed that your robot can reach while
|
||||
translating in meters per second.</dd>
|
||||
<dd><code>attainableMaxRotationalVelocityRadiansPerSecond</code> - The absolute max speed the robot can reach while rotating in
|
||||
radians per second.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="setRawModuleStates(swervelib.math.SwerveModuleState2[],boolean)">
|
||||
<h3>setRawModuleStates</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">setRawModuleStates</span><wbr><span class="parameters">(<a href="math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[] desiredStates,
|
||||
boolean isOpenLoop)</span></div>
|
||||
<div class="block">Set the module states (azimuth and velocity) directly. Used primarily for auto pathing.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>desiredStates</code> - A list of SwerveModuleStates to send to the modules.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable closed-loop.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -585,8 +661,7 @@ loadScripts(document, 'script');</script>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>desiredStates</code> - A list of SwerveModuleStates to send to the modules.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable
|
||||
closed-loop.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use closed-loop velocity control. Set to true to disable closed-loop.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -638,9 +713,9 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="resetOdometry(edu.wpi.first.math.geometry.Pose2d)">
|
||||
<h3>resetOdometry</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">resetOdometry</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d pose)</span></div>
|
||||
<div class="block">Resets odometry to the given pose. Gyro angle and module positions do not need to be reset when
|
||||
calling this method. However, if either gyro angle or module position is reset, this must be
|
||||
called in order for odometry to keep working.</div>
|
||||
<div class="block">Resets odometry to the given pose. Gyro angle and module positions do not need to be reset when calling this
|
||||
method. However, if either gyro angle or module position is reset, this must be called in order for odometry to
|
||||
keep working.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>pose</code> - The pose to set the odometry to</dd>
|
||||
@@ -673,8 +748,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getModulePositions()">
|
||||
<h3>getModulePositions</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModulePosition[]</span> <span class="element-name">getModulePositions</span>()</div>
|
||||
<div class="block">Gets the current module positions (azimuth and wheel position (meters)). Inverts the distance
|
||||
from each module if <a href="#invertOdometry"><code>invertOdometry</code></a> is true.</div>
|
||||
<div class="block">Gets the current module positions (azimuth and wheel position (meters)). Inverts the distance from each module if
|
||||
<a href="#invertOdometry"><code>invertOdometry</code></a> is true.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>A list of SwerveModulePositions containg the current module positions</dd>
|
||||
@@ -759,17 +834,17 @@ loadScripts(document, 'script');</script>
|
||||
<h3>setMaximumSpeed</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaximumSpeed</span><wbr><span class="parameters">(double maximumSpeed,
|
||||
boolean updateModuleFeedforward)</span></div>
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and <a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is
|
||||
used for the <code>setRawModuleStates(SwerveModuleState2[], boolean)</code> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.
|
||||
This function overrides what was placed in the JSON and could damage your motor/robot if set
|
||||
too high or unachievable rates.</div>
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
|
||||
<a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
|
||||
<a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState2[], boolean)</code></a> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions. This function overrides
|
||||
what was placed in the JSON and could damage your motor/robot if set too high or unachievable rates.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>maximumSpeed</code> - Maximum speed for the drive motors in meters / second.</dd>
|
||||
<dd><code>updateModuleFeedforward</code> - Update the swerve module feedforward to account for the new
|
||||
maximum speed. This should be true unless you have replaced the drive motor feedforward
|
||||
with <a href="#replaceSwerveModuleFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)"><code>replaceSwerveModuleFeedforward(SimpleMotorFeedforward)</code></a></dd>
|
||||
<dd><code>updateModuleFeedforward</code> - Update the swerve module feedforward to account for the new maximum speed. This
|
||||
should be true unless you have replaced the drive motor feedforward with
|
||||
<a href="#replaceSwerveModuleFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)"><code>replaceSwerveModuleFeedforward(SimpleMotorFeedforward)</code></a></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -777,11 +852,12 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setMaximumSpeed(double)">
|
||||
<h3>setMaximumSpeed</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaximumSpeed</span><wbr><span class="parameters">(double maximumSpeed)</span></div>
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and <a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is
|
||||
used for the <code>setRawModuleStates(SwerveModuleState2[], boolean)</code> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.
|
||||
This function overrides what was placed in the JSON and could damage your motor/robot if set
|
||||
too high or unachievable rates. Overwrites the <a href="SwerveModule.html#feedforward"><code>SwerveModule.feedforward</code></a>.</div>
|
||||
<div class="block">Set the maximum speed of the drive motors, modified <a href="parser/SwerveControllerConfiguration.html#maxSpeed"><code>SwerveControllerConfiguration.maxSpeed</code></a> and
|
||||
<a href="parser/SwerveDriveConfiguration.html#maxSpeed"><code>SwerveDriveConfiguration.maxSpeed</code></a> which is used for the
|
||||
<a href="#setRawModuleStates(swervelib.math.SwerveModuleState2%5B%5D,boolean)"><code>setRawModuleStates(SwerveModuleState2[], boolean)</code></a> function and
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions. This function overrides
|
||||
what was placed in the JSON and could damage your motor/robot if set too high or unachievable rates. Overwrites the
|
||||
<a href="SwerveModule.html#feedforward"><code>SwerveModule.feedforward</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>maximumSpeed</code> - Maximum speed for the drive motors in meters / second.</dd>
|
||||
@@ -792,8 +868,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="lockPose()">
|
||||
<h3>lockPose</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">lockPose</span>()</div>
|
||||
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move.
|
||||
Forcing the robot to keep the current pose.</div>
|
||||
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move. Forcing the robot to keep
|
||||
the current pose.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
@@ -824,9 +900,9 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="updateOdometry()">
|
||||
<h3>updateOdometry</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateOdometry</span>()</div>
|
||||
<div class="block">Update odometry should be run every loop. Synchronizes module absolute encoders with relative
|
||||
encoders periodically. In simulation mode will also post the pose of each module. Updates
|
||||
SmartDashboard with module encoder readings and states.</div>
|
||||
<div class="block">Update odometry should be run every loop. Synchronizes module absolute encoders with relative encoders
|
||||
periodically. In simulation mode will also post the pose of each module. Updates SmartDashboard with module encoder
|
||||
readings and states.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
@@ -840,7 +916,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)">
|
||||
<h3>setGyroOffset</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setGyroOffset</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Rotation3d offset)</span></div>
|
||||
<div class="block">Set the gyro scope offset to a desired known rotation. Unlike <a href="#setGyro(edu.wpi.first.math.geometry.Rotation3d)"><code>setGyro(Rotation3d)</code></a> it DOES NOT take the current rotation into account.</div>
|
||||
<div class="block">Set the gyro scope offset to a desired known rotation. Unlike <a href="#setGyro(edu.wpi.first.math.geometry.Rotation3d)"><code>setGyro(Rotation3d)</code></a> it DOES NOT
|
||||
take the current rotation into account.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>offset</code> - <code>Rotation3d</code> known offset of the robot for gyroscope to use.</dd>
|
||||
@@ -854,18 +931,21 @@ loadScripts(document, 'script');</script>
|
||||
double timestamp,
|
||||
boolean soft,
|
||||
double trustWorthiness)</span></div>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with the given timestamp of the vision measurement. <br>
|
||||
<b>IT IS HIGHLY RECOMMENDED TO UPDATE YOUR GYROSCOPE OFFSET AFTER USING THIS FUNCTION!</b> <br>
|
||||
To update your gyroscope readings directly use <a href="#setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)"><code>setGyroOffset(Rotation3d)</code></a>.</div>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
|
||||
the given timestamp of the vision measurement. <br/> <b>IT IS HIGHLY RECOMMENDED TO UPDATE YOUR GYROSCOPE OFFSET
|
||||
AFTER USING THIS FUNCTION!</b> <br/> To update your gyroscope readings directly use
|
||||
<a href="#setGyroOffset(edu.wpi.first.math.geometry.Rotation3d)"><code>setGyroOffset(Rotation3d)</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>robotPose</code> - Robot <code>Pose2d</code> as measured by vision.</dd>
|
||||
<dd><code>timestamp</code> - Timestamp the measurement was taken as time since startup, should be taken
|
||||
from <code>Timer.getFPGATimestamp()</code> or similar sources.</dd>
|
||||
<dd><code>soft</code> - Add vision estimate using the <code>PoseEstimator.addVisionMeasurement(Pose2d, double)</code> function, or hard reset
|
||||
odometry with the given position with <code>SwerveDriveOdometry.resetPosition(Rotation2d, SwerveModulePosition[], Pose2d)</code>.</dd>
|
||||
<dd><code>trustWorthiness</code> - Trust level of vision reading when using a soft measurement, used to
|
||||
multiply the standard deviation. Set to 1 for full trust. Higher = Less Weight.</dd>
|
||||
<dd><code>timestamp</code> - Timestamp the measurement was taken as time since startup, should be taken from
|
||||
<code>Timer.getFPGATimestamp()</code> or similar sources.</dd>
|
||||
<dd><code>soft</code> - Add vision estimate using the
|
||||
<code>SwerveDrivePoseEstimator.addVisionMeasurement(Pose2d, double)</code> function, or hard
|
||||
reset odometry with the given position with
|
||||
<code>SwerveDriveOdometry.resetPosition(Rotation2d, SwerveModulePosition[], Pose2d)</code>.</dd>
|
||||
<dd><code>trustWorthiness</code> - Trust level of vision reading when using a soft measurement, used to multiply the standard
|
||||
deviation. Set to 1 for full trust. Higher = Less Weight.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -876,16 +956,19 @@ loadScripts(document, 'script');</script>
|
||||
double timestamp,
|
||||
boolean soft,
|
||||
edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1> visionMeasurementStdDevs)</span></div>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with the given timestamp of the vision measurement.</div>
|
||||
<div class="block">Add a vision measurement to the <code>SwerveDrivePoseEstimator</code> and update the <a href="imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a> gyro reading with
|
||||
the given timestamp of the vision measurement.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>robotPose</code> - Robot <code>Pose2d</code> as measured by vision.</dd>
|
||||
<dd><code>timestamp</code> - Timestamp the measurement was taken as time since startup, should be taken
|
||||
from <code>Timer.getFPGATimestamp()</code> or similar sources.</dd>
|
||||
<dd><code>soft</code> - Add vision estimate using the <code>PoseEstimator.addVisionMeasurement(Pose2d, double)</code> function, or hard reset
|
||||
odometry with the given position with <code>SwerveDriveOdometry.resetPosition(Rotation2d, SwerveModulePosition[], Pose2d)</code>.</dd>
|
||||
<dd><code>timestamp</code> - Timestamp the measurement was taken as time since startup, should be taken from
|
||||
<code>Timer.getFPGATimestamp()</code> or similar sources.</dd>
|
||||
<dd><code>soft</code> - Add vision estimate using the
|
||||
<code>SwerveDrivePoseEstimator.addVisionMeasurement(Pose2d, double)</code> function, or
|
||||
hard reset odometry with the given position with
|
||||
<code>SwerveDriveOdometry.resetPosition(Rotation2d, SwerveModulePosition[], Pose2d)</code>.</dd>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Vision measurement standard deviation that will be sent to the
|
||||
<code>SwerveDrivePoseEstimator</code>.</dd>
|
||||
<code>SwerveDrivePoseEstimator</code>.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -893,8 +976,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setGyro(edu.wpi.first.math.geometry.Rotation3d)">
|
||||
<h3>setGyro</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setGyro</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Rotation3d gyro)</span></div>
|
||||
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object. To reset gyro, set to a new
|
||||
<code>Rotation3d</code> subtracted from the current gyroscopic readings <a href="imu/SwerveIMU.html#getRotation3d()"><code>SwerveIMU.getRotation3d()</code></a>.</div>
|
||||
<div class="block">Set the expected gyroscope angle using a <code>Rotation3d</code> object. To reset gyro, set to a new <code>Rotation3d</code>
|
||||
subtracted from the current gyroscopic readings <a href="imu/SwerveIMU.html#getRotation3d()"><code>SwerveIMU.getRotation3d()</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>gyro</code> - expected gyroscope angle as <code>Rotation3d</code>.</dd>
|
||||
@@ -905,10 +988,12 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getSwerveController()">
|
||||
<h3>getSwerveController</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SwerveController.html" title="class in swervelib">SwerveController</a></span> <span class="element-name">getSwerveController</span>()</div>
|
||||
<div class="block">Helper function to get the <a href="#swerveController"><code>swerveController</code></a> for the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>
|
||||
which can be used to generate <code>ChassisSpeeds</code> for the robot to orient it correctly given
|
||||
axis or angles, and apply <code>SlewRateLimiter</code> to given inputs.
|
||||
Important functions to look at are <a href="SwerveController.html#getTargetSpeeds(double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double)</code></a>, <a href="SwerveController.html#addSlewRateLimiters(edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter)"><code>SwerveController.addSlewRateLimiters(SlewRateLimiter, SlewRateLimiter, SlewRateLimiter)</code></a>, <a href="SwerveController.html#getRawTargetSpeeds(double,double,double)"><code>SwerveController.getRawTargetSpeeds(double, double, double)</code></a>.</div>
|
||||
<div class="block">Helper function to get the <a href="#swerveController"><code>swerveController</code></a> for the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> which can be used to
|
||||
generate <code>ChassisSpeeds</code> for the robot to orient it correctly given axis or angles, and apply
|
||||
<code>SlewRateLimiter</code> to given inputs. Important functions to look at are
|
||||
<a href="SwerveController.html#getTargetSpeeds(double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double)</code></a>,
|
||||
<a href="SwerveController.html#addSlewRateLimiters(edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter)"><code>SwerveController.addSlewRateLimiters(SlewRateLimiter, SlewRateLimiter, SlewRateLimiter)</code></a>,
|
||||
<a href="SwerveController.html#getRawTargetSpeeds(double,double,double)"><code>SwerveController.getRawTargetSpeeds(double, double, double)</code></a>.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> for the <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>.</dd>
|
||||
@@ -930,16 +1015,15 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="resetEncoders()">
|
||||
<h3>resetEncoders</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">resetEncoders</span>()</div>
|
||||
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a
|
||||
reboot, like in autonomous.</div>
|
||||
<div class="block">Reset the drive encoders on the robot, useful when manually resetting the robot without a reboot, like in
|
||||
autonomous.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="setModuleStateOptimization(boolean)">
|
||||
<h3>setModuleStateOptimization</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setModuleStateOptimization</span><wbr><span class="parameters">(boolean optimizationEnabled)</span></div>
|
||||
<div class="block">Configure whether the <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> will be optimized to prevent spinning more
|
||||
than 90deg.</div>
|
||||
<div class="block">Configure whether the <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> will be optimized to prevent spinning more than 90deg.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>optimizationEnabled</code> - Whether the module optimization is enabled.</dd>
|
||||
@@ -950,8 +1034,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="enableSecondOrderKinematics(double)">
|
||||
<h3>enableSecondOrderKinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">enableSecondOrderKinematics</span><wbr><span class="parameters">(double moduleFeedforward)</span></div>
|
||||
<div class="block">Enable second order kinematics for simulation and modifying the feedforward. Second order
|
||||
kinematics could increase accuracy in odometry.</div>
|
||||
<div class="block">Enable second order kinematics for simulation and modifying the feedforward. Second order kinematics could increase
|
||||
accuracy in odometry.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>moduleFeedforward</code> - Module feedforward to apply should be between [-1, 1] excluding 0.</dd>
|
||||
@@ -962,8 +1046,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="enableSecondOrderKinematics(int)">
|
||||
<h3>enableSecondOrderKinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">enableSecondOrderKinematics</span><wbr><span class="parameters">(int motorFreeSpeedRPM)</span></div>
|
||||
<div class="block">Enable second order kinematics with calculated values for the feedforward and return the value
|
||||
used.</div>
|
||||
<div class="block">Enable second order kinematics with calculated values for the feedforward and return the value used.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>motorFreeSpeedRPM</code> - Steering motor free speed RPM.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveModule (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveModule</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib, class: SwerveModule">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -90,11 +91,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>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
||||
<div class="col-first even-row-color"><code>private final <a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Absolute encoder for swerve drive.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Angle offset from the absolute encoder.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve module configuration options.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#feedforward" class="member-name-link">feedforward</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
@@ -113,8 +134,18 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#moduleStateOptimization" class="member-name-link">moduleStateOptimization</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Enable <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> optimizations so the angle is reversed and speed is reversed
|
||||
to ensure the module never turns more than 90deg.</div>
|
||||
<div class="block">Enable <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> optimizations so the angle is reversed and speed is reversed to ensure the module
|
||||
never turns more than 90deg.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#simModule" class="member-name-link">simModule</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Simulated swerve module.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Encoder synchronization queued.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -159,8 +190,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</a>()</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Fetch the <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed
|
||||
configurations.</div>
|
||||
<div class="block">Fetch the <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed configurations.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDriveMotor()" class="member-name-link">getDriveMotor</a>()</code></div>
|
||||
@@ -229,11 +259,38 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="angleOffset">
|
||||
<h3>angleOffset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">double</span> <span class="element-name">angleOffset</span></div>
|
||||
<div class="block">Angle offset from the absolute encoder.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="angleMotor">
|
||||
<h3>angleMotor</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">angleMotor</span></div>
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="driveMotor">
|
||||
<h3>driveMotor</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">driveMotor</span></div>
|
||||
<div class="block">Swerve Motors.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="absoluteEncoder">
|
||||
<h3>absoluteEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span> <span class="element-name">absoluteEncoder</span></div>
|
||||
<div class="block">Absolute encoder for swerve drive.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="moduleNumber">
|
||||
<h3>moduleNumber</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">moduleNumber</span></div>
|
||||
<div class="block">Module number for kinematics, usually 0 to 3. front left -> front right -> back left -> back
|
||||
right.</div>
|
||||
<div class="block">Module number for kinematics, usually 0 to 3. front left -> front right -> back left -> back right.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
@@ -254,8 +311,22 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="moduleStateOptimization">
|
||||
<h3>moduleStateOptimization</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">moduleStateOptimization</span></div>
|
||||
<div class="block">Enable <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> optimizations so the angle is reversed and speed is reversed
|
||||
to ensure the module never turns more than 90deg.</div>
|
||||
<div class="block">Enable <a href="math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> optimizations so the angle is reversed and speed is reversed to ensure the module
|
||||
never turns more than 90deg.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="simModule">
|
||||
<h3>simModule</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></span> <span class="element-name">simModule</span></div>
|
||||
<div class="block">Simulated swerve module.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="synchronizeEncoderQueued">
|
||||
<h3>synchronizeEncoderQueued</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">synchronizeEncoderQueued</span></div>
|
||||
<div class="block">Encoder synchronization queued.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -300,15 +371,14 @@ loadScripts(document, 'script');</script>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDesiredState</span><wbr><span class="parameters">(<a href="math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a> desiredState,
|
||||
boolean isOpenLoop,
|
||||
boolean force)</span></div>
|
||||
<div class="block">Set the desired state of the swerve module. <br>
|
||||
<b>WARNING: If you are not using one of the functions from <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> you may screw up
|
||||
<a href="SwerveDrive.html#kinematics"><code>SwerveDrive.kinematics</code></a></b></div>
|
||||
<div class="block">Set the desired state of the swerve module. <br/><b>WARNING: If you are not using one of the functions from
|
||||
<a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> you may screw up <a href="SwerveDrive.html#kinematics"><code>SwerveDrive.kinematics</code></a></b></div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>desiredState</code> - Desired swerve module state.</dd>
|
||||
<dd><code>isOpenLoop</code> - Whether to use open loop (direct percent) or direct velocity control.</dd>
|
||||
<dd><code>force</code> - Disables optimizations that prevent movement in the angle motor and forces the
|
||||
desired state onto the swerve module.</dd>
|
||||
<dd><code>force</code> - Disables optimizations that prevent movement in the angle motor and forces the desired state
|
||||
onto the swerve module.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -404,8 +474,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getConfiguration()">
|
||||
<h3>getConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></span> <span class="element-name">getConfiguration</span>()</div>
|
||||
<div class="block">Fetch the <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed
|
||||
configurations.</div>
|
||||
<div class="block">Fetch the <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed configurations.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>AnalogAbsoluteEncoderSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>AnalogAbsoluteEncoderSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.encoders, class: AnalogAbsoluteEncoderSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -97,6 +98,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Encoder as Analog Input.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Inversion state of the encoder.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
||||
@@ -182,6 +188,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Encoder as Analog Input.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="inverted">
|
||||
<h3>inverted</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">inverted</span></div>
|
||||
<div class="block">Inversion state of the encoder.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>CANCoderSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<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="2023-08-29">
|
||||
<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">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -262,8 +263,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAbsolutePosition()">
|
||||
<h3>getAbsolutePosition</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
||||
<div class="block">Get the absolute position of the encoder. Sets <a href="SwerveAbsoluteEncoder.html#readingError"><code>SwerveAbsoluteEncoder.readingError</code></a> on
|
||||
erroneous readings.</div>
|
||||
<div class="block">Get the absolute position of the encoder. Sets <a href="SwerveAbsoluteEncoder.html#readingError"><code>SwerveAbsoluteEncoder.readingError</code></a> on erroneous readings.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>CanAndCoderSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>CanAndCoderSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.encoders, class: CanAndCoderSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -97,6 +98,11 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The <code>CANandcoder</code> representing the CANandCoder on the CAN bus.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Inversion state of the encoder.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
||||
@@ -178,6 +184,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">The <code>CANandcoder</code> representing the CANandCoder on the CAN bus.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="inverted">
|
||||
<h3>inverted</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">inverted</span></div>
|
||||
<div class="block">Inversion state of the encoder.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SparkMaxEncoderSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SparkMaxEncoderSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxEncoderSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveAbsoluteEncoder (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveAbsoluteEncoder</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.encoders, class: SwerveAbsoluteEncoder">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -81,8 +82,7 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SwerveAbsoluteEncoder</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">Swerve abstraction class to define a standard interface with absolute encoders for swerve
|
||||
modules..</div>
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.encoders (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.encoders</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.encoders">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -101,8 +102,7 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve
|
||||
modules..</div>
|
||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.encoders Class Hierarchy (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.encoders Class Hierarchy</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-08-29">
|
||||
<meta name="description" content="tree: package: swervelib.encoders">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ADIS16448Swerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>ADIS16448Swerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: ADIS16448Swerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final edu.wpi.first.wpilibj.ADIS16448_IMU</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the ADIS16448.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.ADIS16448_IMU</span> <span class="element-name">imu</span></div>
|
||||
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the ADIS16448.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -165,8 +210,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>ADIS16448Swerve</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ADIS16448Swerve</span>()</div>
|
||||
<div class="block">Construct the ADIS16448 imu and reset default configurations. Publish the gyro to the
|
||||
SmartDashboard.</div>
|
||||
<div class="block">Construct the ADIS16448 imu and reset default configurations. Publish the gyro to the SmartDashboard.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -242,8 +286,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ADIS16470Swerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>ADIS16470Swerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: ADIS16470Swerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final edu.wpi.first.wpilibj.ADIS16470_IMU</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the ADIS16470.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.ADIS16470_IMU</span> <span class="element-name">imu</span></div>
|
||||
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the ADIS16470.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -165,8 +210,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>ADIS16470Swerve</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ADIS16470Swerve</span>()</div>
|
||||
<div class="block">Construct the ADIS16470 imu and reset default configurations. Publish the gyro to the
|
||||
SmartDashboard.</div>
|
||||
<div class="block">Construct the ADIS16470 imu and reset default configurations. Publish the gyro to the SmartDashboard.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -242,8 +286,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>ADXRS450Swerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>ADXRS450Swerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: ADXRS450Swerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final edu.wpi.first.wpilibj.ADXRS450_Gyro</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the ADXRS450.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.ADXRS450_Gyro</span> <span class="element-name">imu</span></div>
|
||||
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the ADXRS450.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -165,8 +210,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>ADXRS450Swerve</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ADXRS450Swerve</span>()</div>
|
||||
<div class="block">Construct the ADXRS450 imu and reset default configurations. Publish the gyro to the
|
||||
SmartDashboard.</div>
|
||||
<div class="block">Construct the ADXRS450 imu and reset default configurations. Publish the gyro to the SmartDashboard.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -242,8 +286,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>AnalogGyroSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>AnalogGyroSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: AnalogGyroSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final edu.wpi.first.wpilibj.AnalogGyro</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#gyro" class="member-name-link">gyro</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Gyroscope object.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the analog gyro.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="gyro">
|
||||
<h3>gyro</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.AnalogGyro</span> <span class="element-name">gyro</span></div>
|
||||
<div class="block">Gyroscope object.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the analog gyro.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -245,8 +290,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>NavXSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>NavXSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: NavXSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private com.kauailabs.navx.frc.AHRS</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#gyro" class="member-name-link">gyro</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">NavX IMU.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the NavX.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="gyro">
|
||||
<h3>gyro</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">com.kauailabs.navx.frc.AHRS</span> <span class="element-name">gyro</span></div>
|
||||
<div class="block">NavX IMU.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the NavX.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -245,8 +290,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Pigeon2Swerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Pigeon2Swerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: Pigeon2Swerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>(package private) com.ctre.phoenix.sensors.WPI_Pigeon2</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Pigeon2 IMU device.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the Pigeon 2.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -161,6 +184,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="return-type">com.ctre.phoenix.sensors.WPI_Pigeon2</span> <span class="element-name">imu</span></div>
|
||||
<div class="block">Pigeon2 IMU device.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the Pigeon 2.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -263,8 +308,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>PigeonSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>PigeonSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: PigeonSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -83,6 +84,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>(package private) com.ctre.phoenix.sensors.WPI_PigeonIMU</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#imu" class="member-name-link">imu</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Pigeon v1 IMU device.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Rotation3d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Offset for the Pigeon.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -156,6 +179,28 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="imu">
|
||||
<h3>imu</h3>
|
||||
<div class="member-signature"><span class="return-type">com.ctre.phoenix.sensors.WPI_PigeonIMU</span> <span class="element-name">imu</span></div>
|
||||
<div class="block">Pigeon v1 IMU device.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="offset">
|
||||
<h3>offset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation3d</span> <span class="element-name">offset</span></div>
|
||||
<div class="block">Offset for the Pigeon.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -245,8 +290,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveIMU.html#getAccel()">getAccel</a></code> in class <code><a href="SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveIMU (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveIMU</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu, class: SwerveIMU">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -226,8 +227,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="getAccel()">
|
||||
<h3>getAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><edu.wpi.first.math.geometry.Translation3d></span> <span class="element-name">getAccel</span>()</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration
|
||||
isn't supported returns empty.</div>
|
||||
<div class="block">Fetch the acceleration [x, y, z] from the IMU in meters per second squared. If acceleration isn't supported returns
|
||||
empty.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd><code>Translation3d</code> of the acceleration as an <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link"><code>Optional</code></a>.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.imu (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.imu</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.imu">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.imu Class Hierarchy (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.imu Class Hierarchy</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-08-29">
|
||||
<meta name="description" content="tree: package: swervelib.imu">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>Matter (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>Matter</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: Matter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveDriveOdometry2 (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveDriveOdometry2</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: SwerveDriveOdometry2">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -44,13 +45,13 @@ loadScripts(document, 'script');</script>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -71,21 +72,66 @@ loadScripts(document, 'script');</script>
|
||||
<h1 title="Class SwerveDriveOdometry2" class="title">Class SwerveDriveOdometry2</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
|
||||
<div class="inheritance">edu.wpi.first.math.kinematics.Odometry<edu.wpi.first.math.kinematics.SwerveDriveWheelPositions>
|
||||
<div class="inheritance">edu.wpi.first.math.kinematics.SwerveDriveOdometry
|
||||
<div class="inheritance">swervelib.math.SwerveDriveOdometry2</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveDriveOdometry2</span>
|
||||
<span class="extends-implements">extends edu.wpi.first.math.kinematics.SwerveDriveOdometry</span></div>
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate
|
||||
estimation. Originally made by Team 1466.</div>
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate estimation.
|
||||
Originally made by Team 1466.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_gyroOffset" class="member-name-link">m_gyroOffset</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Gyro offset.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_kinematics" class="member-name-link">m_kinematics</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve drive kinematics.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_numModules" class="member-name-link">m_numModules</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.geometry.Pose2d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_poseMeters" class="member-name-link">m_poseMeters</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Estimated pose.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_previousAngle" class="member-name-link">m_previousAngle</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Previous gyroscope angle.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.math.kinematics.SwerveModulePosition[]</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_previousModulePositions" class="member-name-link">m_previousModulePositions</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Previous swerve module positions.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.math.kinematics.SwerveModuleState[]</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_zeroModuleStates" class="member-name-link">m_zeroModuleStates</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Zero module states.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -139,15 +185,14 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Rotation2d roll,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Updates the robot's position on the field using forward kinematics and integration of the pose
|
||||
over time.</div>
|
||||
<div class="block">Updates the robot's position on the field using forward kinematics and integration of the pose over time.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-edu.wpi.first.math.kinematics.SwerveDriveOdometry">Methods inherited from class edu.wpi.first.math.kinematics.SwerveDriveOdometry</h3>
|
||||
<code>resetPosition, update, update</code></div>
|
||||
<code>update</code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
@@ -157,6 +202,63 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="m_kinematics">
|
||||
<h3>m_kinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveDriveKinematics</span> <span class="element-name">m_kinematics</span></div>
|
||||
<div class="block">Swerve drive kinematics.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_numModules">
|
||||
<h3>m_numModules</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name">m_numModules</span></div>
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_previousModulePositions">
|
||||
<h3>m_previousModulePositions</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModulePosition[]</span> <span class="element-name">m_previousModulePositions</span></div>
|
||||
<div class="block">Previous swerve module positions.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_zeroModuleStates">
|
||||
<h3>m_zeroModuleStates</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModuleState[]</span> <span class="element-name">m_zeroModuleStates</span></div>
|
||||
<div class="block">Zero module states.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_poseMeters">
|
||||
<h3>m_poseMeters</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Pose2d</span> <span class="element-name">m_poseMeters</span></div>
|
||||
<div class="block">Estimated pose.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_gyroOffset">
|
||||
<h3>m_gyroOffset</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">m_gyroOffset</span></div>
|
||||
<div class="block">Gyro offset.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_previousAngle">
|
||||
<h3>m_previousAngle</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">m_previousAngle</span></div>
|
||||
<div class="block">Previous gyroscope angle.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -231,7 +333,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Returns the position of the robot on the field.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code>getPoseMeters</code> in class <code>edu.wpi.first.math.kinematics.Odometry<edu.wpi.first.math.kinematics.SwerveDriveWheelPositions></code></dd>
|
||||
<dd><code>getPoseMeters</code> in class <code>edu.wpi.first.math.kinematics.SwerveDriveOdometry</code></dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The pose of the robot (x and y are in meters).</dd>
|
||||
</dl>
|
||||
@@ -244,19 +346,18 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Rotation2d pitch,
|
||||
edu.wpi.first.math.geometry.Rotation2d roll,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions)</span></div>
|
||||
<div class="block">Updates the robot's position on the field using forward kinematics and integration of the pose
|
||||
over time. This method automatically calculates the current time to calculate period
|
||||
(difference between two timestamps). The period is used to calculate the change in distance
|
||||
from a velocity. This also takes in an angle parameter which is used instead of the angular
|
||||
rate that is calculated from forward kinematics. This also takes in pitch and roll to allow for
|
||||
more accurate pose estimation on angled surfaces using a rotation matrix.</div>
|
||||
<div class="block">Updates the robot's position on the field using forward kinematics and integration of the pose over time. This
|
||||
method automatically calculates the current time to calculate period (difference between two timestamps). The
|
||||
period is used to calculate the change in distance from a velocity. This also takes in an angle parameter which is
|
||||
used instead of the angular rate that is calculated from forward kinematics. This also takes in pitch and roll to
|
||||
allow for more accurate pose estimation on angled surfaces using a rotation matrix.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>gyroYaw</code> - The yaw reported by the gyro.</dd>
|
||||
<dd><code>pitch</code> - The pitch reported by the gyro.</dd>
|
||||
<dd><code>roll</code> - The roll reported by the gyro.</dd>
|
||||
<dd><code>modulePositions</code> - The current position of all swerve modules. Please provide the positions
|
||||
in the same order in which you instantiated your SwerveDriveKinematics.</dd>
|
||||
<dd><code>modulePositions</code> - The current position of all swerve modules. Please provide the positions in the same order
|
||||
in which you instantiated your SwerveDriveKinematics.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The new pose of the robot.</dd>
|
||||
</dl>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveKinematics2 (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveKinematics2</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: SwerveKinematics2">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -43,14 +44,14 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li>Nested | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -76,26 +77,69 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code>edu.wpi.first.math.kinematics.Kinematics<edu.wpi.first.math.kinematics.SwerveDriveKinematics.SwerveDriveWheelStates,<wbr>edu.wpi.first.math.kinematics.SwerveDriveWheelPositions></code></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveKinematics2</span>
|
||||
<span class="extends-implements">extends edu.wpi.first.math.kinematics.SwerveDriveKinematics</span></div>
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules
|
||||
states from chassis speed. Makes use of <a href="SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> to add the angular velocity
|
||||
that is required of the module as an output.</div>
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
|
||||
speed. Makes use of <a href="SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> to add the angular velocity that is required of the module as an
|
||||
output.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.math.kinematics.SwerveDriveKinematics">Nested classes/interfaces inherited from class edu.wpi.first.math.kinematics.SwerveDriveKinematics</h2>
|
||||
<code>edu.wpi.first.math.kinematics.SwerveDriveKinematics.SwerveDriveWheelStates</code></div>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final org.ejml.simple.SimpleMatrix</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#bigInverseKinematics" class="member-name-link">bigInverseKinematics</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Second order kinematics inverse matrix.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final org.ejml.simple.SimpleMatrix</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_forwardKinematics" class="member-name-link">m_forwardKinematics</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Forward kinematics matrix.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final org.ejml.simple.SimpleMatrix</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_inverseKinematics" class="member-name-link">m_inverseKinematics</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Inverse kinematics matrix.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.wpilibj.Timer</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_moduleAccelTimer" class="member-name-link">m_moduleAccelTimer</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.math.geometry.Translation2d[]</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_modules" class="member-name-link">m_modules</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Location of each swerve module in meters.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final <a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[]</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_moduleStates" class="member-name-link">m_moduleStates</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Swerve module states.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final int</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_numModules" class="member-name-link">m_numModules</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_prevChassisSpeeds" class="member-name-link">m_prevChassisSpeeds</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private edu.wpi.first.math.geometry.Translation2d</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_prevCoR" class="member-name-link">m_prevCoR</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Previous CoR</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_prevModuleAccelTime" class="member-name-link">m_prevModuleAccelTime</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
@@ -137,8 +181,8 @@ loadScripts(document, 'script');</script>
|
||||
double attainableMaxTranslationalSpeedMetersPerSecond,
|
||||
double attainableMaxRotationalVelocityRadiansPerSecond)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well
|
||||
as getting rid of joystick saturation at edges of joystick.</div>
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well as getting rid of
|
||||
joystick saturation at edges of joystick.</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="#toChassisSpeeds(swervelib.math.SwerveModuleState2...)" class="member-name-link">toChassisSpeeds</a><wbr>(<a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>... wheelStates)</code></div>
|
||||
@@ -166,7 +210,7 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-edu.wpi.first.math.kinematics.SwerveDriveKinematics">Methods inherited from class edu.wpi.first.math.kinematics.SwerveDriveKinematics</h3>
|
||||
<code>desaturateWheelSpeeds, desaturateWheelSpeeds, resetHeadings, toChassisSpeeds, toChassisSpeeds, toTwist2d, toWheelSpeeds</code></div>
|
||||
<code>desaturateWheelSpeeds, desaturateWheelSpeeds, toChassisSpeeds</code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
@@ -176,6 +220,81 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="m_inverseKinematics">
|
||||
<h3>m_inverseKinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.ejml.simple.SimpleMatrix</span> <span class="element-name">m_inverseKinematics</span></div>
|
||||
<div class="block">Inverse kinematics matrix.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_forwardKinematics">
|
||||
<h3>m_forwardKinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.ejml.simple.SimpleMatrix</span> <span class="element-name">m_forwardKinematics</span></div>
|
||||
<div class="block">Forward kinematics matrix.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="bigInverseKinematics">
|
||||
<h3>bigInverseKinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">org.ejml.simple.SimpleMatrix</span> <span class="element-name">bigInverseKinematics</span></div>
|
||||
<div class="block">Second order kinematics inverse matrix.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_numModules">
|
||||
<h3>m_numModules</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name">m_numModules</span></div>
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_modules">
|
||||
<h3>m_modules</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.geometry.Translation2d[]</span> <span class="element-name">m_modules</span></div>
|
||||
<div class="block">Location of each swerve module in meters.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_moduleStates">
|
||||
<h3>m_moduleStates</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[]</span> <span class="element-name">m_moduleStates</span></div>
|
||||
<div class="block">Swerve module states.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_moduleAccelTimer">
|
||||
<h3>m_moduleAccelTimer</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.Timer</span> <span class="element-name">m_moduleAccelTimer</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_prevCoR">
|
||||
<h3>m_prevCoR</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.geometry.Translation2d</span> <span class="element-name">m_prevCoR</span></div>
|
||||
<div class="block">Previous CoR</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_prevChassisSpeeds">
|
||||
<h3>m_prevChassisSpeeds</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">m_prevChassisSpeeds</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_prevModuleAccelTime">
|
||||
<h3>m_prevModuleAccelTime</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">m_prevModuleAccelTime</span></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -185,10 +304,10 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="<init>(edu.wpi.first.math.geometry.Translation2d...)">
|
||||
<h3>SwerveKinematics2</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveKinematics2</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Translation2d... wheelsMeters)</span></div>
|
||||
<div class="block">Constructs a swerve drive kinematics object. This takes in a variable number of wheel locations
|
||||
as Translation2ds. The order in which you pass in the wheel locations is the same order that
|
||||
you will receive the module states when performing inverse kinematics. It is also expected that
|
||||
you pass in the module states in the same order when calling the forward kinematics methods.</div>
|
||||
<div class="block">Constructs a swerve drive kinematics object. This takes in a variable number of wheel locations as Translation2ds.
|
||||
The order in which you pass in the wheel locations is the same order that you will receive the module states when
|
||||
performing inverse kinematics. It is also expected that you pass in the module states in the same order when
|
||||
calling the forward kinematics methods.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>wheelsMeters</code> - The locations of the wheels relative to the physical center of the robot.</dd>
|
||||
@@ -211,13 +330,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum.
|
||||
|
||||
<p>Sometimes, after inverse kinematics, the requested speed from one or more modules may be
|
||||
above the max attainable speed for the driving motor on that module. To fix this issue, one can
|
||||
reduce all the wheel speeds to make sure that all requested module speeds are at-or-below the
|
||||
absolute threshold, while maintaining the ratio of speeds between modules.</div>
|
||||
above the max attainable speed for the driving motor on that module. To fix this issue, one can reduce all the
|
||||
wheel speeds to make sure that all requested module speeds are at-or-below the absolute threshold, while
|
||||
maintaining the ratio of speeds between modules.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>moduleStates</code> - Reference to array of module states. The array will be mutated with the
|
||||
normalized speeds!</dd>
|
||||
normalized speeds!</dd>
|
||||
<dd><code>attainableMaxSpeedMetersPerSecond</code> - The absolute max speed that a module can reach.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
@@ -230,23 +349,22 @@ loadScripts(document, 'script');</script>
|
||||
double attainableMaxModuleSpeedMetersPerSecond,
|
||||
double attainableMaxTranslationalSpeedMetersPerSecond,
|
||||
double attainableMaxRotationalVelocityRadiansPerSecond)</span></div>
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well
|
||||
as getting rid of joystick saturation at edges of joystick.
|
||||
<div class="block">Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well as getting rid of
|
||||
joystick saturation at edges of joystick.
|
||||
|
||||
<p>Sometimes, after inverse kinematics, the requested speed from one or more modules may be
|
||||
above the max attainable speed for the driving motor on that module. To fix this issue, one can
|
||||
reduce all the wheel speeds to make sure that all requested module speeds are at-or-below the
|
||||
absolute threshold, while maintaining the ratio of speeds between modules.</div>
|
||||
above the max attainable speed for the driving motor on that module. To fix this issue, one can reduce all the
|
||||
wheel speeds to make sure that all requested module speeds are at-or-below the absolute threshold, while
|
||||
maintaining the ratio of speeds between modules.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>moduleStates</code> - Reference to array of module states. The array will be mutated with the
|
||||
normalized speeds!</dd>
|
||||
<dd><code>moduleStates</code> - Reference to array of module states. The array will be
|
||||
mutated with the normalized speeds!</dd>
|
||||
<dd><code>currentChassisSpeed</code> - The current speed of the robot</dd>
|
||||
<dd><code>attainableMaxModuleSpeedMetersPerSecond</code> - The absolute max speed that a module can reach</dd>
|
||||
<dd><code>attainableMaxTranslationalSpeedMetersPerSecond</code> - The absolute max speed that your robot
|
||||
can reach while translating</dd>
|
||||
<dd><code>attainableMaxRotationalVelocityRadiansPerSecond</code> - The absolute max speed the robot can
|
||||
reach while rotating</dd>
|
||||
<dd><code>attainableMaxTranslationalSpeedMetersPerSecond</code> - The absolute max speed that your robot can reach while
|
||||
translating</dd>
|
||||
<dd><code>attainableMaxRotationalVelocityRadiansPerSecond</code> - The absolute max speed the robot can reach while rotating</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -255,13 +373,13 @@ loadScripts(document, 'script');</script>
|
||||
<h3>toSwerveModuleStates</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[]</span> <span class="element-name">toSwerveModuleStates</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.ChassisSpeeds chassisSpeeds,
|
||||
edu.wpi.first.math.geometry.Translation2d centerOfRotationMeters)</span></div>
|
||||
<div class="block">Performs inverse kinematics to return the module states from a desired chassis velocity. This
|
||||
method is often used to convert joystick values into module speeds and angles.
|
||||
<div class="block">Performs inverse kinematics to return the module states from a desired chassis velocity. This method is often used
|
||||
to convert joystick values into module speeds and angles.
|
||||
|
||||
<p>This function also supports variable centers of rotation. During normal operations, the
|
||||
center of rotation is usually the same as the physical center of the robot; therefore, the
|
||||
argument is defaulted to that use case. However, if you wish to change the center of rotation
|
||||
for evasive maneuvers, vision alignment, or for any other use case, you can do so.
|
||||
center of rotation is usually the same as the physical center of the robot; therefore, the argument is defaulted to
|
||||
that use case. However, if you wish to change the center of rotation for evasive maneuvers, vision alignment, or
|
||||
for any other use case, you can do so.
|
||||
|
||||
<p>In the case that the desired chassis speeds are zero (i.e. the robot will be stationary),
|
||||
the previously calculated module angle will be maintained.</div>
|
||||
@@ -270,13 +388,13 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>toSwerveModuleStates</code> in class <code>edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>chassisSpeeds</code> - The desired chassis speed.</dd>
|
||||
<dd><code>centerOfRotationMeters</code> - The center of rotation. For example, if you set the center of
|
||||
rotation at one corner of the robot and provide a chassis speed that only has a dtheta
|
||||
component, the robot will rotate around that corner.</dd>
|
||||
<dd><code>centerOfRotationMeters</code> - The center of rotation. For example, if you set the center of rotation at one corner
|
||||
of the robot and provide a chassis speed that only has a dtheta component, the robot
|
||||
will rotate around that corner.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>An array containing the module states. Use caution because these module states are not
|
||||
normalized. Sometimes, a user input may cause one of the module speeds to go above the
|
||||
attainable max velocity. Use the <a href="#desaturateWheelSpeeds(swervelib.math.SwerveModuleState2%5B%5D,double)"><code>DesaturateWheelSpeeds</code></a> function to rectify this issue.</dd>
|
||||
<dd>An array containing the module states. Use caution because these module states are not normalized.
|
||||
Sometimes, a user input may cause one of the module speeds to go above the attainable max velocity. Use the
|
||||
<a href="#desaturateWheelSpeeds(swervelib.math.SwerveModuleState2%5B%5D,double)"><code>DesaturateWheelSpeeds</code></a> function to rectify this issue.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -284,8 +402,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="toSwerveModuleStates(edu.wpi.first.math.kinematics.ChassisSpeeds)">
|
||||
<h3>toSwerveModuleStates</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>[]</span> <span class="element-name">toSwerveModuleStates</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.ChassisSpeeds chassisSpeeds)</span></div>
|
||||
<div class="block">Performs inverse kinematics. See <a href="#toSwerveModuleStates(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)"><code>toSwerveModuleStates(ChassisSpeeds, Translation2d)</code></a>
|
||||
toSwerveModuleStates for more information.</div>
|
||||
<div class="block">Performs inverse kinematics. See <a href="#toSwerveModuleStates(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)"><code>toSwerveModuleStates(ChassisSpeeds, Translation2d)</code></a> toSwerveModuleStates
|
||||
for more information.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code>toSwerveModuleStates</code> in class <code>edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></dd>
|
||||
@@ -300,14 +418,14 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="toChassisSpeeds(swervelib.math.SwerveModuleState2...)">
|
||||
<h3>toChassisSpeeds</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">toChassisSpeeds</span><wbr><span class="parameters">(<a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a>... wheelStates)</span></div>
|
||||
<div class="block">Performs forward kinematics to return the resulting chassis state from the given module states.
|
||||
This method is often used for odometry -- determining the robot's position on the field using
|
||||
data from the real-world speed and angle of each module on the robot.</div>
|
||||
<div class="block">Performs forward kinematics to return the resulting chassis state from the given module states. This method is
|
||||
often used for odometry -- determining the robot's position on the field using data from the real-world speed and
|
||||
angle of each module on the robot.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>wheelStates</code> - The state of the modules (as a SwerveModuleState type) as measured from
|
||||
respective encoders and gyros. The order of the swerve module states should be same as
|
||||
passed into the constructor of this class.</dd>
|
||||
<dd><code>wheelStates</code> - The state of the modules (as a SwerveModuleState type) as measured from respective encoders and
|
||||
gyros. The order of the swerve module states should be same as passed into the constructor of
|
||||
this class.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The resulting chassis speed.</dd>
|
||||
</dl>
|
||||
@@ -317,16 +435,16 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="toTwist2d(edu.wpi.first.math.kinematics.SwerveModulePosition...)">
|
||||
<h3>toTwist2d</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.geometry.Twist2d</span> <span class="element-name">toTwist2d</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModulePosition... wheelDeltas)</span></div>
|
||||
<div class="block">Performs forward kinematics to return the resulting chassis state from the given module states.
|
||||
This method is often used for odometry -- determining the robot's position on the field using
|
||||
data from the real-world speed and angle of each module on the robot.</div>
|
||||
<div class="block">Performs forward kinematics to return the resulting chassis state from the given module states. This method is
|
||||
often used for odometry -- determining the robot's position on the field using data from the real-world speed and
|
||||
angle of each module on the robot.</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code>toTwist2d</code> in class <code>edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>wheelDeltas</code> - The latest change in position of the modules (as a SwerveModulePosition
|
||||
type) as measured from respective encoders and gyros. The order of the swerve module states
|
||||
should be same as passed into the constructor of this class.</dd>
|
||||
<dd><code>wheelDeltas</code> - The latest change in position of the modules (as a SwerveModulePosition type) as measured from
|
||||
respective encoders and gyros. The order of the swerve module states should be same as passed
|
||||
into the constructor of this class.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The resulting Twist2d.</dd>
|
||||
</dl>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveMath (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveMath</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: SwerveMath">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -119,73 +120,80 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Algebraically apply a deadband using a piece wise function.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateDegreesPerSteeringRotation(double,double)" class="member-name-link">calculateDegreesPerSteeringRotation</a><wbr>(double angleGearRatio,
|
||||
double pulsePerRotation)</code></div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">calcMaxAccel</a><wbr>(edu.wpi.first.math.geometry.Rotation2d angle,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Matter.html" title="class in swervelib.math">Matter</a>> matter,
|
||||
double robotMass,
|
||||
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> config)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Calculate the degrees per steering rotation for the integrated encoder.</div>
|
||||
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double cof)</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateDegreesPerSteeringRotation(double,double)" class="member-name-link">calculateDegreesPerSteeringRotation</a><wbr>(double angleGearRatio,
|
||||
double pulsePerRotation)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of
|
||||
friction.</div>
|
||||
<div class="block">Calculate the degrees per steering rotation for the integrated encoder.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double,double,double,double,double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double stallTorqueNm,
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double cof)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAcceleration(double,double,double,double,double)" class="member-name-link">calculateMaxAcceleration</a><wbr>(double stallTorqueNm,
|
||||
double gearRatio,
|
||||
double moduleCount,
|
||||
double wheelDiameter,
|
||||
double robotMass)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Calculate the maximum theoretical acceleration without friction.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAngularVelocity(double,double,double)" class="member-name-link">calculateMaxAngularVelocity</a><wbr>(double maxSpeed,
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMaxAngularVelocity(double,double,double)" class="member-name-link">calculateMaxAngularVelocity</a><wbr>(double maxSpeed,
|
||||
double furthestModuleX,
|
||||
double furthestModuleY)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Calculate the maximum angular velocity.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMetersPerRotation(double,double,double)" class="member-name-link">calculateMetersPerRotation</a><wbr>(double wheelDiameter,
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#calculateMetersPerRotation(double,double,double)" class="member-name-link">calculateMetersPerRotation</a><wbr>(double wheelDiameter,
|
||||
double driveGearRatio,
|
||||
double pulsePerRotation)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Calculate the meters per rotation for the integrated encoder.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSwerveModule(swervelib.SwerveModule%5B%5D,boolean,boolean)" class="member-name-link">getSwerveModule</a><wbr>(<a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[] modules,
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getSwerveModule(swervelib.SwerveModule%5B%5D,boolean,boolean)" class="member-name-link">getSwerveModule</a><wbr>(<a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a>[] modules,
|
||||
boolean front,
|
||||
boolean left)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Get the fruthest module from center based on the module locations.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Translation2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity</a><wbr>(edu.wpi.first.math.geometry.Translation2d commandedVelocity,
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Translation2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity</a><wbr>(edu.wpi.first.math.geometry.Translation2d commandedVelocity,
|
||||
edu.wpi.first.math.kinematics.ChassisSpeeds fieldVelocity,
|
||||
edu.wpi.first.math.geometry.Pose2d robotPose,
|
||||
double loopTime,
|
||||
double robotMass,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Matter.html" title="class in swervelib.math">Matter</a>> matter,
|
||||
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> config)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code>.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizeAngle(double)" class="member-name-link">normalizeAngle</a><wbr>(double angle)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Normalize an angle to be within 0 to 360.</div>
|
||||
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope</a><wbr>(double scopeReference,
|
||||
double newAngle)</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#normalizeAngle(double)" class="member-name-link">normalizeAngle</a><wbr>(double angle)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Normalize an angle to be within 0 to 360.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope</a><wbr>(double scopeReference,
|
||||
double newAngle)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Put an angle within the 360 deg scope of a reference.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Twist2d</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#PoseLog(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">PoseLog</a><wbr>(edu.wpi.first.math.geometry.Pose2d transform)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Twist2d</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#PoseLog(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">PoseLog</a><wbr>(edu.wpi.first.math.geometry.Pose2d transform)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Logical inverse of the Pose exponential from 254.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -225,14 +233,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">calculateMetersPerRotation</span><wbr><span class="parameters">(double wheelDiameter,
|
||||
double driveGearRatio,
|
||||
double pulsePerRotation)</span></div>
|
||||
<div class="block">Calculate the meters per rotation for the integrated encoder. Calculation: 4in diameter wheels
|
||||
* pi [circumfrence] / gear ratio.</div>
|
||||
<div class="block">Calculate the meters per rotation for the integrated encoder. Calculation: 4in diameter wheels * pi [circumfrence]
|
||||
/ gear ratio.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>wheelDiameter</code> - Wheel diameter in meters.</dd>
|
||||
<dd><code>driveGearRatio</code> - The gear ratio of the drive motor.</dd>
|
||||
<dd><code>pulsePerRotation</code> - The number of encoder pulses per rotation. 1 if using an integrated
|
||||
encoder.</dd>
|
||||
<dd><code>pulsePerRotation</code> - The number of encoder pulses per rotation. 1 if using an integrated encoder.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>Meters per rotation for the drive motor.</dd>
|
||||
</dl>
|
||||
@@ -273,14 +280,12 @@ loadScripts(document, 'script');</script>
|
||||
<h3>calculateDegreesPerSteeringRotation</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">calculateDegreesPerSteeringRotation</span><wbr><span class="parameters">(double angleGearRatio,
|
||||
double pulsePerRotation)</span></div>
|
||||
<div class="block">Calculate the degrees per steering rotation for the integrated encoder. Encoder conversion
|
||||
values. Drive converts motor rotations to linear wheel distance and steering converts motor
|
||||
rotations to module azimuth.</div>
|
||||
<div class="block">Calculate the degrees per steering rotation for the integrated encoder. Encoder conversion values. Drive converts
|
||||
motor rotations to linear wheel distance and steering converts motor rotations to module azimuth.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>angleGearRatio</code> - The gear ratio of the steering motor.</dd>
|
||||
<dd><code>pulsePerRotation</code> - The number of pulses in a complete rotation for the encoder, 1 if
|
||||
integrated.</dd>
|
||||
<dd><code>pulsePerRotation</code> - The number of pulses in a complete rotation for the encoder, 1 if integrated.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>Degrees per steering rotation for the angle motor.</dd>
|
||||
</dl>
|
||||
@@ -307,8 +312,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="calculateMaxAcceleration(double)">
|
||||
<h3>calculateMaxAcceleration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">calculateMaxAcceleration</span><wbr><span class="parameters">(double cof)</span></div>
|
||||
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of
|
||||
friction.</div>
|
||||
<div class="block">Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>cof</code> - Coefficient of Friction of the wheel grip tape.</dd>
|
||||
@@ -329,8 +333,7 @@ loadScripts(document, 'script');</script>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>stallTorqueNm</code> - Stall torque of driving motor in nM.</dd>
|
||||
<dd><code>gearRatio</code> - Gear ratio for driving motor number of motor rotations until one wheel
|
||||
rotation.</dd>
|
||||
<dd><code>gearRatio</code> - Gear ratio for driving motor number of motor rotations until one wheel rotation.</dd>
|
||||
<dd><code>moduleCount</code> - Number of swerve modules.</dd>
|
||||
<dd><code>wheelDiameter</code> - Wheel diameter in meters.</dd>
|
||||
<dd><code>robotMass</code> - Mass of the robot in kg.</dd>
|
||||
@@ -340,6 +343,27 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)">
|
||||
<h3>calcMaxAccel</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">double</span> <span class="element-name">calcMaxAccel</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Rotation2d angle,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Matter.html" title="class in swervelib.math">Matter</a>> matter,
|
||||
double robotMass,
|
||||
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> config)</span></div>
|
||||
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot. Reads arm position from
|
||||
NetworkTables and is passed the direction in question.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>angle</code> - The direction in which to calculate max acceleration, as a Rotation2d. Note that this is
|
||||
robot-relative.</dd>
|
||||
<dd><code>matter</code> - Matter that the robot is composed of in kg. (Includes chassis)</dd>
|
||||
<dd><code>robotMass</code> - The weight of the robot in kg. (Including manipulators, etc).</dd>
|
||||
<dd><code>config</code> - The swerve drive configuration.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>Maximum acceleration allowed in the robot direction.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="PoseLog(edu.wpi.first.math.geometry.Pose2d)">
|
||||
<h3>PoseLog</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.math.geometry.Twist2d</span> <span class="element-name">PoseLog</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d transform)</span></div>
|
||||
@@ -362,20 +386,21 @@ loadScripts(document, 'script');</script>
|
||||
double robotMass,
|
||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="Matter.html" title="class in swervelib.math">Matter</a>> matter,
|
||||
<a href="../parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> config)</span></div>
|
||||
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code>. Note that this takes and returns field-relative velocities.</div>
|
||||
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.
|
||||
Note that this takes and returns field-relative velocities.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>commandedVelocity</code> - The desired velocity</dd>
|
||||
<dd><code>fieldVelocity</code> - The velocity of the robot within a field relative state.</dd>
|
||||
<dd><code>robotPose</code> - The current pose of the robot.</dd>
|
||||
<dd><code>loopTime</code> - The time it takes to update the velocity in seconds. <b>Note: this should
|
||||
include the 100ms that it takes for a SparkMax velocity to update.</b></dd>
|
||||
<dd><code>loopTime</code> - The time it takes to update the velocity in seconds. <b>Note: this should include the
|
||||
100ms that it takes for a SparkMax velocity to update.</b></dd>
|
||||
<dd><code>matter</code> - Matter that the robot is composed of with position in meters and mass in kg.</dd>
|
||||
<dd><code>robotMass</code> - The weight of the robot in kg. (Including manipulators, etc).</dd>
|
||||
<dd><code>config</code> - The swerve drive configuration.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The limited velocity. This is either the commanded velocity, if attainable, or the
|
||||
closest attainable velocity.</dd>
|
||||
<dd>The limited velocity. This is either the commanded velocity, if attainable, or the closest attainable
|
||||
velocity.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -401,9 +426,8 @@ loadScripts(document, 'script');</script>
|
||||
<h3>placeInAppropriate0To360Scope</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">placeInAppropriate0To360Scope</span><wbr><span class="parameters">(double scopeReference,
|
||||
double newAngle)</span></div>
|
||||
<div class="block">Put an angle within the 360 deg scope of a reference. For example, given a scope reference of
|
||||
756 degrees, assumes the full scope is (720-1080), and places an angle of 22 degrees into it,
|
||||
returning 742 deg.</div>
|
||||
<div class="block">Put an angle within the 360 deg scope of a reference. For example, given a scope reference of 756 degrees, assumes
|
||||
the full scope is (720-1080), and places an angle of 22 degrees into it, returning 742 deg.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>scopeReference</code> - Current Angle (deg)</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveModuleState2 (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveModuleState2</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: SwerveModuleState2">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -128,8 +129,7 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveModuleState,double)" class="member-name-link">SwerveModuleState2</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState state,
|
||||
double omegaRadPerSecond)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Create a <a href="SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> based on the <code>SwerveModuleState</code> with the radians per
|
||||
second defined.</div>
|
||||
<div class="block">Create a <a href="SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> based on the <code>SwerveModuleState</code> with the radians per second defined.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -156,8 +156,8 @@ loadScripts(document, 'script');</script>
|
||||
<a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a> lastState,
|
||||
double moduleSteerFeedForwardClosedLoop)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Minimize the change in heading the desired swerve module state would require by potentially
|
||||
reversing the direction the wheel spins.</div>
|
||||
<div class="block">Minimize the change in heading the desired swerve module state would require by potentially reversing the direction
|
||||
the wheel spins.</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.SwerveModuleState</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toSwerveModuleState()" class="member-name-link">toSwerveModuleState</a>()</code></div>
|
||||
@@ -226,8 +226,7 @@ loadScripts(document, 'script');</script>
|
||||
<h3>SwerveModuleState2</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveModuleState2</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState state,
|
||||
double omegaRadPerSecond)</span></div>
|
||||
<div class="block">Create a <a href="SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> based on the <code>SwerveModuleState</code> with the radians per
|
||||
second defined.</div>
|
||||
<div class="block">Create a <a href="SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> based on the <code>SwerveModuleState</code> with the radians per second defined.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>state</code> - First order kinematic module state.</dd>
|
||||
@@ -250,16 +249,15 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Rotation2d currentAngle,
|
||||
<a href="SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a> lastState,
|
||||
double moduleSteerFeedForwardClosedLoop)</span></div>
|
||||
<div class="block">Minimize the change in heading the desired swerve module state would require by potentially
|
||||
reversing the direction the wheel spins. If this is used with the PIDController class's
|
||||
continuous input functionality, the furthest a wheel will ever rotate is 90 degrees.</div>
|
||||
<div class="block">Minimize the change in heading the desired swerve module state would require by potentially reversing the direction
|
||||
the wheel spins. If this is used with the PIDController class's continuous input functionality, the furthest a
|
||||
wheel will ever rotate is 90 degrees.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>desiredState</code> - The desired state.</dd>
|
||||
<dd><code>currentAngle</code> - The current module angle.</dd>
|
||||
<dd><code>lastState</code> - The last state of the module.</dd>
|
||||
<dd><code>moduleSteerFeedForwardClosedLoop</code> - The module feed forward closed loop for the angle
|
||||
motor.</dd>
|
||||
<dd><code>moduleSteerFeedForwardClosedLoop</code> - The module feed forward closed loop for the angle motor.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>Optimized swerve module state.</dd>
|
||||
</dl>
|
||||
|
||||
@@ -0,0 +1,295 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwervePoseEstimator2.InterpolationRecord</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: SwervePoseEstimator2, class: InterpolationRecord">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../index.html">Overview</a></li>
|
||||
<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="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.math</a></div>
|
||||
<h1 title="Class SwervePoseEstimator2.InterpolationRecord" class="title">Class SwervePoseEstimator2.InterpolationRecord</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
|
||||
<div class="inheritance">swervelib.math.SwervePoseEstimator2.InterpolationRecord</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code>edu.wpi.first.math.interpolation.Interpolatable<<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a>></code></dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>Enclosing class:</dt>
|
||||
<dd><a href="SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">private class </span><span class="element-name type-name-label">SwervePoseEstimator2.InterpolationRecord</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>
|
||||
implements edu.wpi.first.math.interpolation.Interpolatable<<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a>></span></div>
|
||||
<div class="block">Represents an odometry record. The record contains the inputs provided as well as the pose that was observed based
|
||||
on these inputs, as well as the previous record and its inputs.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#gyroAngle" class="member-name-link">gyroAngle</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#gyroPitch" class="member-name-link">gyroPitch</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.math.geometry.Rotation2d</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#gyroRoll" class="member-name-link">gyroRoll</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.math.kinematics.SwerveModulePosition[]</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#modulePositions" class="member-name-link">modulePositions</a></code></div>
|
||||
<div class="col-last odd-row-color"> </div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.math.geometry.Pose2d</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#poseMeters" class="member-name-link">poseMeters</a></code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier</div>
|
||||
<div class="table-header col-second">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private </code></div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(edu.wpi.first.math.geometry.Pose2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D)" class="member-name-link">InterpolationRecord</a><wbr>(edu.wpi.first.math.geometry.Pose2d poseMeters,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyro,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroPitch,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroRoll,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs an Interpolation Record with the specified parameters.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<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> obj)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#interpolate(swervelib.math.SwervePoseEstimator2.InterpolationRecord,double)" class="member-name-link">interpolate</a><wbr>(<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a> endValue,
|
||||
double t)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Return the interpolated record.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="poseMeters">
|
||||
<h3>poseMeters</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.geometry.Pose2d</span> <span class="element-name">poseMeters</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="gyroAngle">
|
||||
<h3>gyroAngle</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">gyroAngle</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="gyroPitch">
|
||||
<h3>gyroPitch</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">gyroPitch</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="gyroRoll">
|
||||
<h3>gyroRoll</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">gyroRoll</span></div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="modulePositions">
|
||||
<h3>modulePositions</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModulePosition[]</span> <span class="element-name">modulePositions</span></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>(edu.wpi.first.math.geometry.Pose2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition[])">
|
||||
<h3>InterpolationRecord</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="element-name">InterpolationRecord</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d poseMeters,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyro,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroPitch,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroRoll,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions)</span></div>
|
||||
<div class="block">Constructs an Interpolation Record with the specified parameters.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>poseMeters</code> - The pose observed given the current sensor inputs and the previous pose.</dd>
|
||||
<dd><code>gyro</code> - The current gyro angle.</dd>
|
||||
<dd><code>gyroPitch</code> - The current gyro pitch.</dd>
|
||||
<dd><code>gyroRoll</code> - The current gyro roll.</dd>
|
||||
<dd><code>modulePositions</code> - The distances and rotations measured at each wheel.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="interpolate(swervelib.math.SwervePoseEstimator2.InterpolationRecord,double)">
|
||||
<h3>interpolate</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></span> <span class="element-name">interpolate</span><wbr><span class="parameters">(<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a> endValue,
|
||||
double t)</span></div>
|
||||
<div class="block">Return the interpolated record. This object is assumed to be the starting position, or lower bound.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code>interpolate</code> in interface <code>edu.wpi.first.math.interpolation.Interpolatable<<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a>></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>endValue</code> - The upper bound, or end.</dd>
|
||||
<dd><code>t</code> - How far between the lower and upper bound we are. This should be bounded in [0, 1].</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>The interpolated value.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="equals(java.lang.Object)">
|
||||
<h3>equals</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<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> obj)</span></div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><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></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="hashCode()">
|
||||
<h3>hashCode</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div>
|
||||
<dl class="notes">
|
||||
<dt>Overrides:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><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></code></dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwervePoseEstimator2 (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwervePoseEstimator2</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math, class: SwervePoseEstimator2">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -43,14 +44,14 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -77,11 +78,70 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwervePoseEstimator2</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">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to
|
||||
achieve a more accurate estimation, originally made by Team 1466.</div>
|
||||
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to achieve a more
|
||||
accurate estimation, originally made by Team 1466.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="caption"><span>Nested Classes</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private class </code></div>
|
||||
<div class="col-second even-row-color"><code><a href="SwervePoseEstimator2.InterpolationRecord.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Represents an odometry record.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_kinematics" class="member-name-link">m_kinematics</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Swerve drive kinematics.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final int</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_numModules" class="member-name-link">m_numModules</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final <a href="SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_odometry" class="member-name-link">m_odometry</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Enhanced swerve drive odometry.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.math.interpolation.TimeInterpolatableBuffer<<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_poseBuffer" class="member-name-link">m_poseBuffer</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Interpolation buffer.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#m_q" class="member-name-link">m_q</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Matrix quotient.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N3></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#m_visionK" class="member-name-link">m_visionK</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Vision standard deviations.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
@@ -95,8 +155,7 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions,
|
||||
edu.wpi.first.math.geometry.Pose2d initialPoseMeters)</code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Constructs a SwerveDrivePoseEstimator with default standard deviations for the model and vision
|
||||
measurements.</div>
|
||||
<div class="block">Constructs a SwerveDrivePoseEstimator with default standard deviations for the model and vision measurements.</div>
|
||||
</div>
|
||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.geometry.Rotation2d,edu.wpi.first.math.kinematics.SwerveModulePosition%5B%5D,edu.wpi.first.math.geometry.Pose2d,edu.wpi.first.math.Matrix,edu.wpi.first.math.Matrix)" class="member-name-link">SwervePoseEstimator2</a><wbr>(edu.wpi.first.math.kinematics.SwerveDriveKinematics kinematics,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroAngle,
|
||||
@@ -180,6 +239,56 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="m_kinematics">
|
||||
<h3>m_kinematics</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveDriveKinematics</span> <span class="element-name">m_kinematics</span></div>
|
||||
<div class="block">Swerve drive kinematics.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_odometry">
|
||||
<h3>m_odometry</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></span> <span class="element-name">m_odometry</span></div>
|
||||
<div class="block">Enhanced swerve drive odometry.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_q">
|
||||
<h3>m_q</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1></span> <span class="element-name">m_q</span></div>
|
||||
<div class="block">Matrix quotient.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_numModules">
|
||||
<h3>m_numModules</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name">m_numModules</span></div>
|
||||
<div class="block">Number of swerve modules.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_poseBuffer">
|
||||
<h3>m_poseBuffer</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.interpolation.TimeInterpolatableBuffer<<a href="SwervePoseEstimator2.InterpolationRecord.html" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a>></span> <span class="element-name">m_poseBuffer</span></div>
|
||||
<div class="block">Interpolation buffer.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="m_visionK">
|
||||
<h3>m_visionK</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N3></span> <span class="element-name">m_visionK</span></div>
|
||||
<div class="block">Vision standard deviations.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -192,12 +301,11 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroAngle,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions,
|
||||
edu.wpi.first.math.geometry.Pose2d initialPoseMeters)</span></div>
|
||||
<div class="block">Constructs a SwerveDrivePoseEstimator with default standard deviations for the model and vision
|
||||
measurements.
|
||||
<div class="block">Constructs a SwerveDrivePoseEstimator with default standard deviations for the model and vision measurements.
|
||||
|
||||
<p>The default standard deviations of the model states are 0.1 meters for x, 0.1 meters for y,
|
||||
and 0.1 radians for heading. The default standard deviations of the vision measurements are 0.9
|
||||
meters for x, 0.9 meters for y, and 0.9 radians for heading.</div>
|
||||
and 0.1 radians for heading. The default standard deviations of the vision measurements are 0.9 meters for x, 0.9
|
||||
meters for y, and 0.9 radians for heading.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>kinematics</code> - A correctly-configured kinematics object for your drivetrain.</dd>
|
||||
@@ -223,12 +331,12 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>gyroAngle</code> - The current gyro angle.</dd>
|
||||
<dd><code>modulePositions</code> - The current distance and rotation measurements of the swerve modules.</dd>
|
||||
<dd><code>initialPoseMeters</code> - The starting pose estimate.</dd>
|
||||
<dd><code>stateStdDevs</code> - Standard deviations of the pose estimate (x position in meters, y position
|
||||
in meters, and heading in radians). Increase these numbers to trust your state estimate
|
||||
less.</dd>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Standard deviations of the vision pose measurement (x position
|
||||
in meters, y position in meters, and heading in radians). Increase these numbers to trust
|
||||
the vision pose measurement less.</dd>
|
||||
<dd><code>stateStdDevs</code> - Standard deviations of the pose estimate (x position in meters, y position in
|
||||
meters, and heading in radians). Increase these numbers to trust your state
|
||||
estimate less.</dd>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Standard deviations of the vision pose measurement (x position in meters, y
|
||||
position in meters, and heading in radians). Increase these numbers to trust the
|
||||
vision pose measurement less.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -244,14 +352,13 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setVisionMeasurementStdDevs(edu.wpi.first.math.Matrix)">
|
||||
<h3>setVisionMeasurementStdDevs</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setVisionMeasurementStdDevs</span><wbr><span class="parameters">(edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1> visionMeasurementStdDevs)</span></div>
|
||||
<div class="block">Sets the pose estimator's trust of global measurements. This might be used to change trust in
|
||||
vision measurements after the autonomous period, or to change trust as distance to a vision
|
||||
target increases.</div>
|
||||
<div class="block">Sets the pose estimator's trust of global measurements. This might be used to change trust in vision measurements
|
||||
after the autonomous period, or to change trust as distance to a vision target increases.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Standard deviations of the vision measurements. Increase these
|
||||
numbers to trust global measurements from vision less. This matrix is in the form [x, y,
|
||||
theta]^T, with units in meters and radians.</dd>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Standard deviations of the vision measurements. Increase these numbers to trust
|
||||
global measurements from vision less. This matrix is in the form [x, y, theta]^T,
|
||||
with units in meters and radians.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -289,23 +396,23 @@ loadScripts(document, 'script');</script>
|
||||
<h3>addVisionMeasurement</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addVisionMeasurement</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d visionRobotPoseMeters,
|
||||
double timestampSeconds)</span></div>
|
||||
<div class="block">Adds a vision measurement to the Kalman Filter. This will correct the odometry pose estimate
|
||||
while still accounting for measurement noise.
|
||||
<div class="block">Adds a vision measurement to the Kalman Filter. This will correct the odometry pose estimate while still accounting
|
||||
for measurement noise.
|
||||
|
||||
<p>This method can be called as infrequently as you want, as long as you are calling <code>SwerveDrivePoseEstimator.update(edu.wpi.first.math.geometry.Rotation2d, edu.wpi.first.math.kinematics.SwerveModulePosition[])</code> every loop.
|
||||
|
||||
<p>To promote stability of the pose estimate and make it robust to bad vision data, we
|
||||
recommend only adding vision measurements that are already within one meter or so of the
|
||||
current pose estimate.</div>
|
||||
recommend only adding vision measurements that are already within one meter or so of the current pose estimate.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>visionRobotPoseMeters</code> - The pose of the robot as measured by the vision camera.</dd>
|
||||
<dd><code>timestampSeconds</code> - The timestamp of the vision measurement in seconds. Note that if you
|
||||
don't use your own time source by calling <code>SwerveDrivePoseEstimator.updateWithTime(double, Rotation2d, SwerveModulePosition[])</code> then
|
||||
you must use a timestamp with an epoch since FPGA startup (i.e., the epoch of this
|
||||
timestamp is the same epoch as <code>Timer.getFPGATimestamp()</code>.)
|
||||
This means that you should use <code>Timer.getFPGATimestamp()</code> as
|
||||
your time source or sync the epochs.</dd>
|
||||
<dd><code>timestampSeconds</code> - The timestamp of the vision measurement in seconds. Note that if you don't use your
|
||||
own time source by calling
|
||||
<code>SwerveDrivePoseEstimator.updateWithTime(double, Rotation2d, SwerveModulePosition[])</code> then you must use a timestamp with an epoch since FPGA
|
||||
startup (i.e., the epoch of this timestamp is the same epoch as
|
||||
<code>Timer.getFPGATimestamp()</code>.) This means that you should
|
||||
use <code>Timer.getFPGATimestamp()</code> as your time source or sync
|
||||
the epochs.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -315,29 +422,30 @@ loadScripts(document, 'script');</script>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addVisionMeasurement</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d visionRobotPoseMeters,
|
||||
double timestampSeconds,
|
||||
edu.wpi.first.math.Matrix<edu.wpi.first.math.numbers.N3,<wbr>edu.wpi.first.math.numbers.N1> visionMeasurementStdDevs)</span></div>
|
||||
<div class="block">Adds a vision measurement to the Kalman Filter. This will correct the odometry pose estimate
|
||||
while still accounting for measurement noise.
|
||||
<div class="block">Adds a vision measurement to the Kalman Filter. This will correct the odometry pose estimate while still accounting
|
||||
for measurement noise.
|
||||
|
||||
<p>This method can be called as infrequently as you want, as long as you are calling <code>SwerveDrivePoseEstimator.update(edu.wpi.first.math.geometry.Rotation2d, edu.wpi.first.math.kinematics.SwerveModulePosition[])</code> every loop.
|
||||
|
||||
<p>To promote stability of the pose estimate and make it robust to bad vision data, we
|
||||
recommend only adding vision measurements that are already within one meter or so of the
|
||||
current pose estimate.
|
||||
recommend only adding vision measurements that are already within one meter or so of the current pose estimate.
|
||||
|
||||
<p>Note that the vision measurement standard deviations passed into this method will continue
|
||||
to apply to future measurements until a subsequent call to <code>PoseEstimator.setVisionMeasurementStdDevs(Matrix)</code> or this method.</div>
|
||||
to apply to future measurements until a subsequent call to
|
||||
<code>SwerveDrivePoseEstimator.setVisionMeasurementStdDevs(Matrix)</code> or this method.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>visionRobotPoseMeters</code> - The pose of the robot as measured by the vision camera.</dd>
|
||||
<dd><code>timestampSeconds</code> - The timestamp of the vision measurement in seconds. Note that if you
|
||||
don't use your own time source by calling <code>SwerveDrivePoseEstimator.updateWithTime(double, Rotation2d, SwerveModulePosition[])</code>, then
|
||||
you must use a timestamp with an epoch since FPGA startup (i.e., the epoch of this
|
||||
timestamp is the same epoch as <code>Timer.getFPGATimestamp()</code>).
|
||||
This means that you should use <code>Timer.getFPGATimestamp()</code> as
|
||||
your time source in this case.</dd>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Standard deviations of the vision pose measurement (x position
|
||||
in meters, y position in meters, and heading in radians). Increase these numbers to trust
|
||||
the vision pose measurement less.</dd>
|
||||
<dd><code>timestampSeconds</code> - The timestamp of the vision measurement in seconds. Note that if you don't use your
|
||||
own time source by calling
|
||||
<code>SwerveDrivePoseEstimator.updateWithTime(double, Rotation2d, SwerveModulePosition[])</code>, then you must use a timestamp with an epoch since FPGA
|
||||
startup (i.e., the epoch of this timestamp is the same epoch as
|
||||
<code>Timer.getFPGATimestamp()</code>). This means that you should
|
||||
use <code>Timer.getFPGATimestamp()</code> as your time source in
|
||||
this case.</dd>
|
||||
<dd><code>visionMeasurementStdDevs</code> - Standard deviations of the vision pose measurement (x position in meters, y
|
||||
position in meters, and heading in radians). Increase these numbers to trust the
|
||||
vision pose measurement less.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -348,8 +456,7 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroPitch,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroRoll,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions)</span></div>
|
||||
<div class="block">Updates the pose estimator with wheel encoder and gyro information. This should be called every
|
||||
loop.</div>
|
||||
<div class="block">Updates the pose estimator with wheel encoder and gyro information. This should be called every loop.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>gyroAngle</code> - The current gyro angle.</dd>
|
||||
@@ -369,8 +476,7 @@ loadScripts(document, 'script');</script>
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroPitch,
|
||||
edu.wpi.first.math.geometry.Rotation2d gyroRoll,
|
||||
edu.wpi.first.math.kinematics.SwerveModulePosition[] modulePositions)</span></div>
|
||||
<div class="block">Updates the pose estimator with wheel encoder and gyro information. This should be called every
|
||||
loop.</div>
|
||||
<div class="block">Updates the pose estimator with wheel encoder and gyro information. This should be called every loop.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>currentTimeSeconds</code> - Time at which this method was called, in seconds.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.math (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.math</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.math">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -60,7 +61,8 @@ loadScripts(document, 'script');</script>
|
||||
<hr>
|
||||
<div class="package-signature">package <span class="element-name">swervelib.math</span></div>
|
||||
<section class="package-description" id="package-description">
|
||||
<div class="block">Mathematics for swerve drives. Original second order kinematics was developed by Team 3181 <a href="https://github.com/pittsfordrobotics/ChargedUp2023/tree/master/src/main/java/com/team3181/lib/swerve">here.
|
||||
<div class="block">Mathematics for swerve drives. Original second order kinematics was developed by Team 3181
|
||||
<a href="https://github.com/pittsfordrobotics/ChargedUp2023/tree/master/src/main/java/com/team3181/lib/swerve">here.
|
||||
</a></div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
@@ -90,13 +92,12 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveDriveOdometry2.html" title="class in swervelib.math">SwerveDriveOdometry2</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate
|
||||
estimation.</div>
|
||||
<div class="block">Clone of <code>SwerveDriveOdometry</code> except uses gyro pitch and roll to achieve a more accurate estimation.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveKinematics2.html" title="class in swervelib.math">SwerveKinematics2</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules
|
||||
states from chassis speed.</div>
|
||||
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
|
||||
speed.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
@@ -108,8 +109,8 @@ loadScripts(document, 'script');</script>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwervePoseEstimator2.html" title="class in swervelib.math">SwervePoseEstimator2</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to
|
||||
achieve a more accurate estimation, originally made by Team 1466.</div>
|
||||
<div class="block">Clone of <code>SwerveDrivePoseEstimator</code> which takes into account gyroscope pitch and roll to achieve a more
|
||||
accurate estimation, originally made by Team 1466.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.math Class Hierarchy (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.math Class Hierarchy</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-08-29">
|
||||
<meta name="description" content="tree: package: swervelib.math">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -59,20 +60,16 @@ loadScripts(document, 'script');</script>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a></li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.Odometry<T>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveKinematics
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="SwerveKinematics2.html" class="type-name-link" title="class in swervelib.math">SwerveKinematics2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveOdometry
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="SwerveDriveOdometry2.html" class="type-name-link" title="class in swervelib.math">SwerveDriveOdometry2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveDriveKinematics (implements edu.wpi.first.math.kinematics.Kinematics<S,<wbr>P>)
|
||||
<ul>
|
||||
<li class="circle">swervelib.math.<a href="SwerveKinematics2.html" class="type-name-link" title="class in swervelib.math">SwerveKinematics2</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">swervelib.math.<a href="SwerveMath.html" class="type-name-link" title="class in swervelib.math">SwerveMath</a></li>
|
||||
<li class="circle">edu.wpi.first.math.kinematics.SwerveModuleState (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>)
|
||||
<ul>
|
||||
@@ -80,6 +77,7 @@ loadScripts(document, 'script');</script>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="circle">swervelib.math.<a href="SwervePoseEstimator2.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2</a></li>
|
||||
<li class="circle">swervelib.math.<a href="SwervePoseEstimator2.InterpolationRecord.html" class="type-name-link" title="class in swervelib.math">SwervePoseEstimator2.InterpolationRecord</a> (implements edu.wpi.first.math.interpolation.Interpolatable<T>)</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SparkMaxBrushedMotorSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SparkMaxBrushedMotorSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxBrushedMotorSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -102,14 +103,19 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Integrated encoder.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>com.revrobotics.CANSparkMax</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
|
||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>com.revrobotics.CANSparkMax</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">SparkMAX Instance.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>com.revrobotics.SparkMaxPIDController</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>com.revrobotics.SparkMaxPIDController</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -229,8 +235,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int currentLimit)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean inverted)</code></div>
|
||||
@@ -315,6 +321,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="factoryDefaultOccurred">
|
||||
<h3>factoryDefaultOccurred</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">factoryDefaultOccurred</span></div>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
@@ -337,10 +350,8 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>motor</code> - The SwerveMotor as a SparkMax object.</dd>
|
||||
<dd><code>isDriveMotor</code> - Is the motor being initialized a drive motor?</dd>
|
||||
<dd><code>encoderType</code> - <code>SparkMaxRelativeEncoder.Type</code> of encoder to use for the <code>CANSparkMax</code> device.</dd>
|
||||
<dd><code>countsPerRevolution</code> - The number of encoder pulses for the <code>SparkMaxRelativeEncoder.Type</code> encoder per
|
||||
revolution.</dd>
|
||||
<dd><code>useDataPortQuadEncoder</code> - Use the encoder attached to the data port of the spark max for a
|
||||
quadrature encoder.</dd>
|
||||
<dd><code>countsPerRevolution</code> - The number of encoder pulses for the <code>SparkMaxRelativeEncoder.Type</code> encoder per revolution.</dd>
|
||||
<dd><code>useDataPortQuadEncoder</code> - Use the encoder attached to the data port of the spark max for a quadrature encoder.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -358,10 +369,8 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>id</code> - CAN ID of the SparkMax.</dd>
|
||||
<dd><code>isDriveMotor</code> - Is the motor being initialized a drive motor?</dd>
|
||||
<dd><code>encoderType</code> - <code>SparkMaxRelativeEncoder.Type</code> of encoder to use for the <code>CANSparkMax</code> device.</dd>
|
||||
<dd><code>countsPerRevolution</code> - The number of encoder pulses for the <code>SparkMaxRelativeEncoder.Type</code> encoder per
|
||||
revolution.</dd>
|
||||
<dd><code>useDataPortQuadEncoder</code> - Use the encoder attached to the data port of the spark max for a
|
||||
quadrature encoder.</dd>
|
||||
<dd><code>countsPerRevolution</code> - The number of encoder pulses for the <code>SparkMaxRelativeEncoder.Type</code> encoder per revolution.</dd>
|
||||
<dd><code>useDataPortQuadEncoder</code> - Use the encoder attached to the data port of the spark max for a quadrature encoder.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -390,8 +399,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setCurrentLimit(int)">
|
||||
<h3>setCurrentLimit</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCurrentLimit</span><wbr><span class="parameters">(int currentLimit)</span></div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in
|
||||
conjunction with voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
|
||||
voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#setCurrentLimit(int)">setCurrentLimit</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
@@ -480,8 +489,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="configureIntegratedEncoder(double)">
|
||||
<h3>configureIntegratedEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configureIntegratedEncoder</span><wbr><span class="parameters">(double positionConversionFactor)</span></div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for
|
||||
position and velocity.</div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for position and velocity.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#configureIntegratedEncoder(double)">configureIntegratedEncoder</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
|
||||
268
docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html
Normal file
268
docs/swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html
Normal file
@@ -0,0 +1,268 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SparkMaxSwerve.SparkMAX_slotIdx</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxSwerve, enum: SparkMAX_slotIdx">
|
||||
<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-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
</noscript>
|
||||
<div class="flex-box">
|
||||
<header role="banner" class="flex-header">
|
||||
<nav role="navigation">
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<div class="top-nav" id="navbar-top">
|
||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
||||
<li><a href="../../index.html">Overview</a></li>
|
||||
<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="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="sub-nav">
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||||
<li><a href="#enum-constant-summary">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li><a href="#enum-constant-detail">Enum Constants</a> | </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
||||
</div>
|
||||
</div>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
||||
</header>
|
||||
<div class="flex-content">
|
||||
<main role="main">
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<div class="header">
|
||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.motors</a></div>
|
||||
<h1 title="Enum Class SparkMaxSwerve.SparkMAX_slotIdx" class="title">Enum Class SparkMaxSwerve.SparkMAX_slotIdx</h1>
|
||||
</div>
|
||||
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
|
||||
<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>>
|
||||
<div class="inheritance">swervelib.motors.SparkMaxSwerve.SparkMAX_slotIdx</div>
|
||||
</div>
|
||||
</div>
|
||||
<section class="class-description" id="class-description">
|
||||
<dl class="notes">
|
||||
<dt>All Implemented Interfaces:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
|
||||
</dl>
|
||||
<dl class="notes">
|
||||
<dt>Enclosing class:</dt>
|
||||
<dd><a href="SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dd>
|
||||
</dl>
|
||||
<hr>
|
||||
<div class="type-signature"><span class="modifiers">static enum </span><span class="element-name type-name-label">SparkMaxSwerve.SparkMAX_slotIdx</span>
|
||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>></span></div>
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="inherited-list">
|
||||
<h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>>></code></div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="constants-summary" id="enum-constant-summary">
|
||||
<h2>Enum Constant Summary</h2>
|
||||
<div class="caption"><span>Enum Constants</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-header col-first">Enum Constant</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code><a href="#Position" class="member-name-link">Position</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Slot 1, used for position PID's.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code><a href="#Simulation" class="member-name-link">Simulation</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Slot 3, used arbitrarily.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code><a href="#Velocity" class="member-name-link">Velocity</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Slot 2, used for velocity PID's.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="constructor-summary" id="constructor-summary">
|
||||
<h2>Constructor Summary</h2>
|
||||
<div class="caption"><span>Constructors</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier</div>
|
||||
<div class="table-header col-second">Constructor</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>private </code></div>
|
||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx</a>()</code></div>
|
||||
<div class="col-last even-row-color"> </div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="method-summary" id="method-summary">
|
||||
<h2>Method Summary</h2>
|
||||
<div id="method-summary-table">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<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> name)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>[]</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Returns an array containing the constants of this enum class, in
|
||||
the order they are declared.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<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></h3>
|
||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ ENUM CONSTANT DETAIL =========== -->
|
||||
<li>
|
||||
<section class="constant-details" id="enum-constant-detail">
|
||||
<h2>Enum Constant Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="Position">
|
||||
<h3>Position</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span> <span class="element-name">Position</span></div>
|
||||
<div class="block">Slot 1, used for position PID's.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="Velocity">
|
||||
<h3>Velocity</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span> <span class="element-name">Velocity</span></div>
|
||||
<div class="block">Slot 2, used for velocity PID's.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="Simulation">
|
||||
<h3>Simulation</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span> <span class="element-name">Simulation</span></div>
|
||||
<div class="block">Slot 3, used arbitrarily. (Documentation show simulations).</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
<h2>Constructor Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="<init>()">
|
||||
<h3>SparkMAX_slotIdx</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="element-name">SparkMAX_slotIdx</span>()</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
<li>
|
||||
<section class="method-details" id="method-detail">
|
||||
<h2>Method Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="values()">
|
||||
<h3>values</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a>[]</span> <span class="element-name">values</span>()</div>
|
||||
<div class="block">Returns an array containing the constants of this enum class, in
|
||||
the order they are declared.</div>
|
||||
<dl class="notes">
|
||||
<dt>Returns:</dt>
|
||||
<dd>an array containing the constants of this enum class, in the order they are declared</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="valueOf(java.lang.String)">
|
||||
<h3>valueOf</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<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> name)</span></div>
|
||||
<div class="block">Returns the enum constant of this class with the specified name.
|
||||
The string must match <i>exactly</i> an identifier used to declare an
|
||||
enum constant in this class. (Extraneous whitespace characters are
|
||||
not permitted.)</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>name</code> - the name of the enum constant to be returned.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>the enum constant with the specified name</dd>
|
||||
<dt>Throws:</dt>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd>
|
||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SparkMaxSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SparkMaxSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors, class: SparkMaxSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -43,7 +44,7 @@ loadScripts(document, 'script');</script>
|
||||
<div>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Summary: </li>
|
||||
<li>Nested | </li>
|
||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
||||
<li><a href="#field-summary">Field</a> | </li>
|
||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
||||
<li><a href="#method-summary">Method</a></li>
|
||||
@@ -83,6 +84,23 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="summary">
|
||||
<ul class="summary-list">
|
||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||||
<li>
|
||||
<section class="nested-class-summary" id="nested-class-summary">
|
||||
<h2>Nested Class Summary</h2>
|
||||
<div class="caption"><span>Nested Classes</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color"><code>(package private) static enum </code></div>
|
||||
<div class="col-second even-row-color"><code><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</li>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
@@ -102,14 +120,19 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Integrated encoder.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>com.revrobotics.CANSparkMax</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
|
||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>com.revrobotics.CANSparkMax</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">SparkMAX Instance.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>com.revrobotics.SparkMaxPIDController</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>com.revrobotics.SparkMaxPIDController</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#pid" class="member-name-link">pid</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -223,8 +246,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int currentLimit)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean inverted)</code></div>
|
||||
@@ -309,6 +332,13 @@ loadScripts(document, 'script');</script>
|
||||
<div class="block">Closed-loop PID controller.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="factoryDefaultOccurred">
|
||||
<h3>factoryDefaultOccurred</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">factoryDefaultOccurred</span></div>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
@@ -368,8 +398,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setCurrentLimit(int)">
|
||||
<h3>setCurrentLimit</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCurrentLimit</span><wbr><span class="parameters">(int currentLimit)</span></div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in
|
||||
conjunction with voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
|
||||
voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#setCurrentLimit(int)">setCurrentLimit</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
@@ -458,8 +488,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="configureIntegratedEncoder(double)">
|
||||
<h3>configureIntegratedEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configureIntegratedEncoder</span><wbr><span class="parameters">(double positionConversionFactor)</span></div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for
|
||||
position and velocity.</div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for position and velocity.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#configureIntegratedEncoder(double)">configureIntegratedEncoder</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveMotor (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveMotor</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors, class: SwerveMotor">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -190,8 +191,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int currentLimit)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean inverted)</code></div>
|
||||
@@ -308,8 +309,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="configureIntegratedEncoder(double)">
|
||||
<h3>configureIntegratedEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">configureIntegratedEncoder</span><wbr><span class="parameters">(double positionConversionFactor)</span></div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for
|
||||
position and velocity.</div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for position and velocity.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>positionConversionFactor</code> - The conversion factor to apply for position.</dd>
|
||||
@@ -456,8 +456,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setCurrentLimit(int)">
|
||||
<h3>setCurrentLimit</h3>
|
||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">setCurrentLimit</span><wbr><span class="parameters">(int currentLimit)</span></div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in
|
||||
conjunction with voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
|
||||
voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>currentLimit</code> - Current limit in AMPS at free speed.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>TalonFXSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>TalonFXSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors, class: TalonFXSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -50,7 +51,7 @@ loadScripts(document, 'script');</script>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -87,6 +88,47 @@ loadScripts(document, 'script');</script>
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#configChanged" class="member-name-link">configChanged</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">If the TalonFX configuration has changed.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final com.ctre.phoenix.motorcontrol.can.TalonFXConfiguration</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Current TalonFX configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>(package private) com.ctre.phoenix.motorcontrol.can.WPI_TalonFX</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">TalonFX motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#nominalVoltage" class="member-name-link">nominalVoltage</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#positionConversionFactor" class="member-name-link">positionConversionFactor</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3>
|
||||
<code><a href="SwerveMotor.html#isDriveMotor">isDriveMotor</a></code></div>
|
||||
@@ -220,8 +262,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int currentLimit)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean inverted)</code></div>
|
||||
@@ -273,6 +315,79 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="factoryDefaultOccurred">
|
||||
<h3>factoryDefaultOccurred</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">factoryDefaultOccurred</span></div>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.motors.TalonFXSwerve.factoryDefaultOccurred">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="configuration">
|
||||
<h3>configuration</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">com.ctre.phoenix.motorcontrol.can.TalonFXConfiguration</span> <span class="element-name">configuration</span></div>
|
||||
<div class="block">Current TalonFX configuration.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="absoluteEncoder">
|
||||
<h3>absoluteEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">absoluteEncoder</span></div>
|
||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.motors.TalonFXSwerve.absoluteEncoder">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="motor">
|
||||
<h3>motor</h3>
|
||||
<div class="member-signature"><span class="return-type">com.ctre.phoenix.motorcontrol.can.WPI_TalonFX</span> <span class="element-name">motor</span></div>
|
||||
<div class="block">TalonFX motor controller.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="positionConversionFactor">
|
||||
<h3>positionConversionFactor</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">positionConversionFactor</span></div>
|
||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="configChanged">
|
||||
<h3>configChanged</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">configChanged</span></div>
|
||||
<div class="block">If the TalonFX configuration has changed.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nominalVoltage">
|
||||
<h3>nominalVoltage</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">nominalVoltage</span></div>
|
||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -368,21 +483,20 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="configureIntegratedEncoder(double)">
|
||||
<h3>configureIntegratedEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configureIntegratedEncoder</span><wbr><span class="parameters">(double positionConversionFactor)</span></div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for
|
||||
position and velocity.</div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for position and velocity.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#configureIntegratedEncoder(double)">configureIntegratedEncoder</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>positionConversionFactor</code> - The conversion factor to apply for position.
|
||||
<p><br>
|
||||
Degrees: <br>
|
||||
<code>
|
||||
<p><br>
|
||||
Degrees: <br>
|
||||
<code>
|
||||
360 / (angleGearRatio * encoderTicksPerRotation)
|
||||
</code><br>
|
||||
<p><br>
|
||||
Meters:<br>
|
||||
<code>
|
||||
<p><br>
|
||||
Meters:<br>
|
||||
<code>
|
||||
(Math.PI * wheelDiameter) / (driveGearRatio * encoderTicksPerRotation)
|
||||
</code></dd>
|
||||
</dl>
|
||||
@@ -417,8 +531,8 @@ loadScripts(document, 'script');</script>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>CANStatus1</code> - Applied Motor Output, Fault Information, Limit Switch Information</dd>
|
||||
<dd><code>CANStatus2</code> - Selected Sensor Position (PID 0), Selected Sensor Velocity (PID 0), Brushed
|
||||
Supply Current Measurement, Sticky Fault Information</dd>
|
||||
<dd><code>CANStatus2</code> - Selected Sensor Position (PID 0), Selected Sensor Velocity (PID 0), Brushed Supply Current
|
||||
Measurement, Sticky Fault Information</dd>
|
||||
<dd><code>CANStatus3</code> - Quadrature Information</dd>
|
||||
<dd><code>CANStatus4</code> - Analog Input, Supply Battery Voltage, Controller Temperature</dd>
|
||||
<dd><code>CANStatus8</code> - Pulse Width Information</dd>
|
||||
@@ -427,8 +541,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>CANStatus13</code> - PID0 (Primary PID) Information</dd>
|
||||
<dd><code>CANStatus14</code> - PID1 (Auxiliary PID) Information</dd>
|
||||
<dd><code>CANStatus21</code> - Integrated Sensor Position (Talon FX), Integrated Sensor Velocity (Talon FX)</dd>
|
||||
<dd><code>CANStatusCurrent</code> - Brushless Supply Current Measurement, Brushless Stator Current
|
||||
Measurement</dd>
|
||||
<dd><code>CANStatusCurrent</code> - Brushless Supply Current Measurement, Brushless Stator Current Measurement</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -613,8 +726,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setCurrentLimit(int)">
|
||||
<h3>setCurrentLimit</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCurrentLimit</span><wbr><span class="parameters">(int currentLimit)</span></div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in
|
||||
conjunction with voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
|
||||
voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#setCurrentLimit(int)">setCurrentLimit</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>TalonSRXSwerve (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>TalonSRXSwerve</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors, class: TalonSRXSwerve">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -50,7 +51,7 @@ loadScripts(document, 'script');</script>
|
||||
</ul>
|
||||
<ul class="sub-nav-list">
|
||||
<li>Detail: </li>
|
||||
<li>Field | </li>
|
||||
<li><a href="#field-detail">Field</a> | </li>
|
||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
||||
<li><a href="#method-detail">Method</a></li>
|
||||
</ul>
|
||||
@@ -87,6 +88,47 @@ loadScripts(document, 'script');</script>
|
||||
<li>
|
||||
<section class="field-summary" id="field-summary">
|
||||
<h2>Field Summary</h2>
|
||||
<div class="caption"><span>Fields</span></div>
|
||||
<div class="summary-table three-column-summary">
|
||||
<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>private final boolean</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#configChanged" class="member-name-link">configChanged</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">If the TalonFX configuration has changed.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private final com.ctre.phoenix.motorcontrol.can.TalonSRXConfiguration</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Current TalonFX configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private final boolean</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>(package private) com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#motor" class="member-name-link">motor</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">TalonSRX motor controller.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#nominalVoltage" class="member-name-link">nominalVoltage</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>private double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#positionConversionFactor" class="member-name-link">positionConversionFactor</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="inherited-list">
|
||||
<h3 id="fields-inherited-from-class-swervelib.motors.SwerveMotor">Fields inherited from class swervelib.motors.<a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></h3>
|
||||
<code><a href="SwerveMotor.html#isDriveMotor">isDriveMotor</a></code></div>
|
||||
@@ -214,8 +256,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCurrentLimit(int)" class="member-name-link">setCurrentLimit</a><wbr>(int currentLimit)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<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>
|
||||
<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>
|
||||
</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setInverted(boolean)" class="member-name-link">setInverted</a><wbr>(boolean inverted)</code></div>
|
||||
@@ -267,6 +309,79 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
<section class="details">
|
||||
<ul class="details-list">
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
<li>
|
||||
<section class="field-details" id="field-detail">
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="factoryDefaultOccurred">
|
||||
<h3>factoryDefaultOccurred</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">factoryDefaultOccurred</span></div>
|
||||
<div class="block">Factory default already occurred.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.motors.TalonSRXSwerve.factoryDefaultOccurred">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="configuration">
|
||||
<h3>configuration</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">com.ctre.phoenix.motorcontrol.can.TalonSRXConfiguration</span> <span class="element-name">configuration</span></div>
|
||||
<div class="block">Current TalonFX configuration.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="absoluteEncoder">
|
||||
<h3>absoluteEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name">absoluteEncoder</span></div>
|
||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
||||
<dl class="notes">
|
||||
<dt>See Also:</dt>
|
||||
<dd>
|
||||
<ul class="see-list">
|
||||
<li><a href="../../constant-values.html#swervelib.motors.TalonSRXSwerve.absoluteEncoder">Constant Field Values</a></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="motor">
|
||||
<h3>motor</h3>
|
||||
<div class="member-signature"><span class="return-type">com.ctre.phoenix.motorcontrol.can.WPI_TalonSRX</span> <span class="element-name">motor</span></div>
|
||||
<div class="block">TalonSRX motor controller.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="positionConversionFactor">
|
||||
<h3>positionConversionFactor</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">positionConversionFactor</span></div>
|
||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="configChanged">
|
||||
<h3>configChanged</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">configChanged</span></div>
|
||||
<div class="block">If the TalonFX configuration has changed.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="nominalVoltage">
|
||||
<h3>nominalVoltage</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">nominalVoltage</span></div>
|
||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</li>
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
<li>
|
||||
<section class="constructor-details" id="constructor-detail">
|
||||
@@ -347,21 +462,20 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="configureIntegratedEncoder(double)">
|
||||
<h3>configureIntegratedEncoder</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configureIntegratedEncoder</span><wbr><span class="parameters">(double positionConversionFactor)</span></div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for
|
||||
position and velocity.</div>
|
||||
<div class="block">Configure the integrated encoder for the swerve module. Sets the conversion factors for position and velocity.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#configureIntegratedEncoder(double)">configureIntegratedEncoder</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>positionConversionFactor</code> - The conversion factor to apply for position.
|
||||
<p><br>
|
||||
Degrees: <br>
|
||||
<code>
|
||||
<p><br>
|
||||
Degrees: <br>
|
||||
<code>
|
||||
360 / (angleGearRatio * encoderTicksPerRotation)
|
||||
</code><br>
|
||||
<p><br>
|
||||
Meters:<br>
|
||||
<code>
|
||||
<p><br>
|
||||
Meters:<br>
|
||||
<code>
|
||||
(Math.PI * wheelDiameter) / (driveGearRatio * encoderTicksPerRotation)
|
||||
</code></dd>
|
||||
</dl>
|
||||
@@ -396,8 +510,8 @@ loadScripts(document, 'script');</script>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>CANStatus1</code> - Applied Motor Output, Fault Information, Limit Switch Information</dd>
|
||||
<dd><code>CANStatus2</code> - Selected Sensor Position (PID 0), Selected Sensor Velocity (PID 0), Brushed
|
||||
Supply Current Measurement, Sticky Fault Information</dd>
|
||||
<dd><code>CANStatus2</code> - Selected Sensor Position (PID 0), Selected Sensor Velocity (PID 0), Brushed Supply Current
|
||||
Measurement, Sticky Fault Information</dd>
|
||||
<dd><code>CANStatus3</code> - Quadrature Information</dd>
|
||||
<dd><code>CANStatus4</code> - Analog Input, Supply Battery Voltage, Controller Temperature</dd>
|
||||
<dd><code>CANStatus8</code> - Pulse Width Information</dd>
|
||||
@@ -406,8 +520,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>CANStatus13</code> - PID0 (Primary PID) Information</dd>
|
||||
<dd><code>CANStatus14</code> - PID1 (Auxiliary PID) Information</dd>
|
||||
<dd><code>CANStatus21</code> - Integrated Sensor Position (Talon FX), Integrated Sensor Velocity (Talon FX)</dd>
|
||||
<dd><code>CANStatusCurrent</code> - Brushless Supply Current Measurement, Brushless Stator Current
|
||||
Measurement</dd>
|
||||
<dd><code>CANStatusCurrent</code> - Brushless Supply Current Measurement, Brushless Stator Current Measurement</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -592,8 +705,8 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="setCurrentLimit(int)">
|
||||
<h3>setCurrentLimit</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setCurrentLimit</span><wbr><span class="parameters">(int currentLimit)</span></div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in
|
||||
conjunction with voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<div class="block">Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with
|
||||
voltage compensation. This is useful to protect the motor from current spikes.</div>
|
||||
<dl class="notes">
|
||||
<dt>Specified by:</dt>
|
||||
<dd><code><a href="SwerveMotor.html#setCurrentLimit(int)">setCurrentLimit</a></code> in class <code><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></dd>
|
||||
|
||||
@@ -1,21 +1,26 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.motors (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.motors</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.motors">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
<script type="text/javascript">var pathtoroot = "../../";
|
||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
||||
var oddRowColor = "odd-row-color";
|
||||
var tableTab = "table-tab";
|
||||
var activeTableTab = "active-table-tab";
|
||||
var pathtoroot = "../../";
|
||||
loadScripts(document, 'script');</script>
|
||||
<noscript>
|
||||
<div>JavaScript is disabled on your browser.</div>
|
||||
@@ -31,7 +36,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -79,8 +84,9 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
<li>
|
||||
<div id="class-summary">
|
||||
<div class="caption"><span>Classes</span></div>
|
||||
<div class="summary-table two-column-summary">
|
||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div>
|
||||
<div id="class-summary.tabpanel" role="tabpanel">
|
||||
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
|
||||
<div class="table-header col-first">Class</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
|
||||
@@ -91,20 +97,25 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab3">
|
||||
<div class="block">REV Slots for PID configuration.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></div>
|
||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></div>
|
||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
||||
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib.motors Class Hierarchy (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib.motors Class Hierarchy</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-08-29">
|
||||
<meta name="description" content="tree: package: swervelib.motors">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../../index-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -70,6 +71,20 @@ loadScripts(document, 'script');</script>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="hierarchy">
|
||||
<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
||||
<ul>
|
||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
||||
<ul>
|
||||
<li class="circle">swervelib.motors.<a href="SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</main>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib">
|
||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-declaration-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li class="nav-bar-cell1-rev">Package</li>
|
||||
<li>Class</li>
|
||||
<li><a href="package-tree.html">Tree</a></li>
|
||||
<li><a href="../index-all.html">Index</a></li>
|
||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../help-doc.html#package">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>swervelib Class Hierarchy (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>swervelib Class Hierarchy</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-08-29">
|
||||
<meta name="description" content="tree: package: swervelib">
|
||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="package-tree-page">
|
||||
@@ -31,7 +32,7 @@ loadScripts(document, 'script');</script>
|
||||
<li><a href="package-summary.html">Package</a></li>
|
||||
<li>Class</li>
|
||||
<li class="nav-bar-cell1-rev">Tree</li>
|
||||
<li><a href="../index-all.html">Index</a></li>
|
||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../help-doc.html#tree">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>PIDFConfig (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>PIDFConfig</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: PIDFConfig">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveControllerConfiguration (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveControllerConfiguration</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveControllerConfiguration">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -31,7 +32,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -205,8 +206,8 @@ loadScripts(document, 'script');</script>
|
||||
<h3>SwerveControllerConfiguration</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveControllerConfiguration</span><wbr><span class="parameters">(<a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> driveCfg,
|
||||
<a href="PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> headingPIDF)</span></div>
|
||||
<div class="block">Construct the swerve controller configuration. Assumes hypotenuse deadband of 0.5 (minimum
|
||||
radius for angle to be set on angle joystick is .5 of the controller).</div>
|
||||
<div class="block">Construct the swerve controller configuration. Assumes hypotenuse deadband of 0.5 (minimum radius for angle to be
|
||||
set on angle joystick is .5 of the controller).</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>driveCfg</code> - Drive configuration.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveDriveConfiguration (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveDriveConfiguration</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveDriveConfiguration">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveModuleConfiguration (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveModuleConfiguration</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModuleConfiguration">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -396,8 +397,7 @@ loadScripts(document, 'script');</script>
|
||||
<dd><code>velocityPIDF</code> - Velocity PIDF configuration.</dd>
|
||||
<dd><code>maxSpeed</code> - Maximum speed in meters per second.</dd>
|
||||
<dd><code>physicalCharacteristics</code> - Physical characteristics of the swerve module.</dd>
|
||||
<dd><code>angleMotorEncoderPulsePerRevolution</code> - The encoder pulse per revolution for the angle motor
|
||||
encoder.</dd>
|
||||
<dd><code>angleMotorEncoderPulsePerRevolution</code> - The encoder pulse per revolution for the angle motor encoder.</dd>
|
||||
<dd><code>name</code> - The name for the swerve module.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
@@ -416,8 +416,8 @@ loadScripts(document, 'script');</script>
|
||||
double maxSpeed,
|
||||
<a href="SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a> physicalCharacteristics,
|
||||
<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> name)</span></div>
|
||||
<div class="block">Construct a configuration object for swerve modules. Assumes the absolute encoder and drive
|
||||
motor are not inverted.</div>
|
||||
<div class="block">Construct a configuration object for swerve modules. Assumes the absolute encoder and drive motor are not
|
||||
inverted.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>driveMotor</code> - Drive <a href="../motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</dd>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveModulePhysicalCharacteristics (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveModulePhysicalCharacteristics</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveModulePhysicalCharacteristics">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -31,7 +32,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -129,9 +130,8 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-first even-row-color"><code>final double</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#moduleSteerFFCL" class="member-name-link">moduleSteerFFCL</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should
|
||||
be adjusted so that your drive train does not drift towards the direction you are rotating
|
||||
while you translate.</div>
|
||||
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
|
||||
your drive train does not drift towards the direction you are rotating while you translate.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>final double</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#optimalVoltage" class="member-name-link">optimalVoltage</a></code></div>
|
||||
@@ -216,8 +216,7 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="driveGearRatio">
|
||||
<h3>driveGearRatio</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">driveGearRatio</span></div>
|
||||
<div class="block">Drive gear ratio. How many times the motor has to spin before the wheel makes a complete
|
||||
rotation.</div>
|
||||
<div class="block">Drive gear ratio. How many times the motor has to spin before the wheel makes a complete rotation.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
@@ -287,9 +286,9 @@ loadScripts(document, 'script');</script>
|
||||
<section class="detail" id="moduleSteerFFCL">
|
||||
<h3>moduleSteerFFCL</h3>
|
||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">double</span> <span class="element-name">moduleSteerFFCL</span></div>
|
||||
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should
|
||||
be adjusted so that your drive train does not drift towards the direction you are rotating
|
||||
while you translate. When set to 0 the calculated kV will be used.</div>
|
||||
<div class="block">Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that
|
||||
your drive train does not drift towards the direction you are rotating while you translate. When set to 0 the
|
||||
calculated kV will be used.</div>
|
||||
</section>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -319,25 +318,21 @@ loadScripts(document, 'script');</script>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>driveGearRatio</code> - Gear ratio of the drive motor. Number of motor rotations to rotate the
|
||||
wheel.</dd>
|
||||
<dd><code>angleGearRatio</code> - Gear ratio of the angle motor. Number of motor rotations to spin the
|
||||
wheel.</dd>
|
||||
wheel.</dd>
|
||||
<dd><code>angleGearRatio</code> - Gear ratio of the angle motor. Number of motor rotations to spin the wheel.</dd>
|
||||
<dd><code>wheelDiameter</code> - Wheel diameter in meters.</dd>
|
||||
<dd><code>wheelGripCoefficientOfFriction</code> - Wheel grip coefficient of friction on carpet given by
|
||||
manufacturer.</dd>
|
||||
<dd><code>wheelGripCoefficientOfFriction</code> - Wheel grip coefficient of friction on carpet given by manufacturer.</dd>
|
||||
<dd><code>optimalVoltage</code> - Optimal robot voltage.</dd>
|
||||
<dd><code>driveMotorCurrentLimit</code> - Current limit for the drive motor.</dd>
|
||||
<dd><code>angleMotorCurrentLimit</code> - Current limit for the angle motor.</dd>
|
||||
<dd><code>driveMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor.
|
||||
(Prevents over drawing power from battery)</dd>
|
||||
<dd><code>angleMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor.
|
||||
(Prevents overdrawing power and power loss).</dd>
|
||||
<dd><code>driveEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for
|
||||
integrated encoders.</dd>
|
||||
<dd><code>angleEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for
|
||||
integrated encoders.</dd>
|
||||
<dd><code>moduleSteerFFCL</code> - The kV applied to the steering motor to ensure your drivetrain does not
|
||||
drift towards a direction when rotating while translating.</dd>
|
||||
<dd><code>driveMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor. (Prevents
|
||||
over drawing power from battery)</dd>
|
||||
<dd><code>angleMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor. (Prevents
|
||||
overdrawing power and power loss).</dd>
|
||||
<dd><code>driveEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for integrated encoders.</dd>
|
||||
<dd><code>angleEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for integrated encoders.</dd>
|
||||
<dd><code>moduleSteerFFCL</code> - The kV applied to the steering motor to ensure your drivetrain does not drift
|
||||
towards a direction when rotating while translating.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
@@ -351,24 +346,20 @@ loadScripts(document, 'script');</script>
|
||||
double angleMotorRampRate,
|
||||
int driveEncoderPulsePerRotation,
|
||||
int angleEncoderPulsePerRotation)</span></div>
|
||||
<div class="block">Construct the swerve module physical characteristics. Assume coefficient of friction is 1.19
|
||||
(taken from blue nitrile on carpet from Studica) and optimal voltage is 12v. Assumes the drive
|
||||
motor current limit is 40A, and the angle motor current limit is 20A.</div>
|
||||
<div class="block">Construct the swerve module physical characteristics. Assume coefficient of friction is 1.19 (taken from blue
|
||||
nitrile on carpet from Studica) and optimal voltage is 12v. Assumes the drive motor current limit is 40A, and the
|
||||
angle motor current limit is 20A.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>driveGearRatio</code> - Gear ratio of the drive motor. Number of motor rotations to rotate the
|
||||
wheel.</dd>
|
||||
<dd><code>angleGearRatio</code> - Gear ratio of the angle motor. Number of motor rotations to spin the
|
||||
wheel.</dd>
|
||||
<dd><code>driveGearRatio</code> - Gear ratio of the drive motor. Number of motor rotations to rotate the wheel.</dd>
|
||||
<dd><code>angleGearRatio</code> - Gear ratio of the angle motor. Number of motor rotations to spin the wheel.</dd>
|
||||
<dd><code>wheelDiameter</code> - Wheel diameter in meters.</dd>
|
||||
<dd><code>driveMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor.
|
||||
(Prevents over drawing power from battery)</dd>
|
||||
<dd><code>angleMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor.
|
||||
(Prevents overdrawing power and power loss).</dd>
|
||||
<dd><code>driveEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for
|
||||
integrated encoders.</dd>
|
||||
<dd><code>angleEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for
|
||||
integrated encoders.</dd>
|
||||
<dd><code>driveMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor. (Prevents over
|
||||
drawing power from battery)</dd>
|
||||
<dd><code>angleMotorRampRate</code> - The time in seconds to go from 0 to full throttle on the motor. (Prevents
|
||||
overdrawing power and power loss).</dd>
|
||||
<dd><code>driveEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for integrated encoders.</dd>
|
||||
<dd><code>angleEncoderPulsePerRotation</code> - The number of encoder pulses per motor rotation, 1 for integrated encoders.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
|
||||
@@ -1,17 +1,18 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<!-- Generated by javadoc (17) -->
|
||||
<title>SwerveParser (YAGSL-Lib API)</title>
|
||||
<!-- Generated by javadoc (17) on Tue Aug 29 19:54:45 CDT 2023 -->
|
||||
<title>SwerveParser</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-08-29">
|
||||
<meta name="description" content="declaration: package: swervelib.parser, class: SwerveParser">
|
||||
<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.6.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
||||
</head>
|
||||
<body class="class-declaration-page">
|
||||
@@ -35,7 +36,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-all.html">Index</a></li>
|
||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
@@ -95,24 +96,29 @@ loadScripts(document, 'script');</script>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Parsed controllerproperties.json</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static <a href="json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a>[]</code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#moduleJsons" class="member-name-link">moduleJsons</a></code></div>
|
||||
<div class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#moduleConfigs" class="member-name-link">moduleConfigs</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Module number mapped to the JSON name.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static <a href="json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a>[]</code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#moduleJsons" class="member-name-link">moduleJsons</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Array holding the module jsons given in <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json"><code>SwerveDriveJson</code></a>.</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static <a href="json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#physicalPropertiesJson" class="member-name-link">physicalPropertiesJson</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>static <a href="json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#physicalPropertiesJson" class="member-name-link">physicalPropertiesJson</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Parsed modules/physicalproperties.json</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color"><code>static <a href="json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="col-first even-row-color"><code>static <a href="json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="block">Parsed modules/pidfproperties.json</div>
|
||||
</div>
|
||||
<div class="col-first even-row-color"><code>static <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></code></div>
|
||||
<div class="col-second even-row-color"><code><a href="#swerveDriveJson" class="member-name-link">swerveDriveJson</a></code></div>
|
||||
<div class="col-last even-row-color">
|
||||
<div class="col-first odd-row-color"><code>static <a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></code></div>
|
||||
<div class="col-second odd-row-color"><code><a href="#swerveDriveJson" class="member-name-link">swerveDriveJson</a></code></div>
|
||||
<div class="col-last odd-row-color">
|
||||
<div class="block">Parsed swervedrive.json</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -144,17 +150,27 @@ loadScripts(document, 'script');</script>
|
||||
<div class="table-header col-first">Modifier and Type</div>
|
||||
<div class="table-header col-second">Method</div>
|
||||
<div class="table-header col-last">Description</div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive()" class="member-name-link">createSwerveDrive</a>()</code></div>
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkDirectory(java.io.File)" class="member-name-link">checkDirectory</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> directory)</code></div>
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Check directory structure.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSwerveDrive()" class="member-name-link">createSwerveDrive</a>()</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Create <a href="../SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> from JSON configuration directory.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a></code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName</a><wbr>(<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> name,
|
||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="../SwerveModule.html" title="class in swervelib">SwerveModule</a></code></div>
|
||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getModuleConfigurationByName(java.lang.String,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">getModuleConfigurationByName</a><wbr>(<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> name,
|
||||
<a href="SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> driveConfiguration)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
||||
<div class="block">Get the swerve module by the json name.</div>
|
||||
</div>
|
||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private com.fasterxml.jackson.databind.JsonNode</code></div>
|
||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#openJson(java.io.File)" class="member-name-link">openJson</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> file)</code></div>
|
||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
||||
<div class="block">Open JSON file.</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -173,6 +189,13 @@ loadScripts(document, 'script');</script>
|
||||
<h2>Field Details</h2>
|
||||
<ul class="member-list">
|
||||
<li>
|
||||
<section class="detail" id="moduleConfigs">
|
||||
<h3>moduleConfigs</h3>
|
||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link">HashMap</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">moduleConfigs</span></div>
|
||||
<div class="block">Module number mapped to the JSON name.</div>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="swerveDriveJson">
|
||||
<h3>swerveDriveJson</h3>
|
||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></span> <span class="element-name">swerveDriveJson</span></div>
|
||||
@@ -253,6 +276,30 @@ loadScripts(document, 'script');</script>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="openJson(java.io.File)">
|
||||
<h3>openJson</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">com.fasterxml.jackson.databind.JsonNode</span> <span class="element-name">openJson</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> file)</span></div>
|
||||
<div class="block">Open JSON file.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>file</code> - JSON File to open.</dd>
|
||||
<dt>Returns:</dt>
|
||||
<dd>JsonNode of file.</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="checkDirectory(java.io.File)">
|
||||
<h3>checkDirectory</h3>
|
||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">checkDirectory</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> directory)</span></div>
|
||||
<div class="block">Check directory structure.</div>
|
||||
<dl class="notes">
|
||||
<dt>Parameters:</dt>
|
||||
<dd><code>directory</code> - JSON Configuration Directory</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</li>
|
||||
<li>
|
||||
<section class="detail" id="createSwerveDrive()">
|
||||
<h3>createSwerveDrive</h3>
|
||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../SwerveDrive.html" title="class in swervelib">SwerveDrive</a></span> <span class="element-name">createSwerveDrive</span>()</div>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user