mirror of
https://github.com/BroncBotz3481/YAGSL
synced 2026-06-19 06:21:40 +00:00
2463 lines
216 KiB
HTML
2463 lines
216 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) -->
|
|
<title>Index (YAGSL-Lib API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="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.6.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="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:K">K</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a href="#I:X">X</a> <a href="#I:Y">Y</a> <a href="#I:Z">Z</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>
|
|
<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/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/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/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/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/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/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>
|
|
<h2 class="title" id="I:B">B</h2>
|
|
<dl class="index">
|
|
<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>
|
|
<h2 class="title" id="I:C">C</h2>
|
|
<dl class="index">
|
|
<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/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/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>
|
|
<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/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/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>
|
|
</dl>
|
|
<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>
|
|
</dl>
|
|
<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#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/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>
|
|
<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/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>
|
|
</dl>
|
|
<h2 class="title" id="I:H">H</h2>
|
|
<dl class="index">
|
|
<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>
|
|
<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/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/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/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>
|
|
<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>
|
|
<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/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/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 <code>SwerveMath.calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code>.</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>
|
|
<h2 class="title" id="I:M">M</h2>
|
|
<dl class="index">
|
|
<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/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/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/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>
|
|
</dl>
|
|
<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/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>
|
|
<h2 class="title" id="I:O">O</h2>
|
|
<dl class="index">
|
|
<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/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>
|
|
<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/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/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/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>
|
|
<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>
|
|
<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/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>
|
|
</dl>
|
|
<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 <code>SwerveDrive.setRawModuleStates(SwerveModuleState2[], boolean)</code> 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 <code>SwerveDrive.setRawModuleStates(SwerveModuleState2[], boolean)</code> 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/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/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/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/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/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/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>
|
|
<h2 class="title" id="I:T">T</h2>
|
|
<dl class="index">
|
|
<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/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/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/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>
|
|
<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>
|
|
<h2 class="title" id="I:V">V</h2>
|
|
<dl class="index">
|
|
<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/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/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/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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:K">K</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a href="#I:X">X</a> <a href="#I:Y">Y</a> <a href="#I:Z">Z</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></main>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|