301 Permanently Moved
@@ -1,312 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>All Classes and Interfaces</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="class index">
|
|
||||||
<meta name="generator" content="javadoc/AllClassesIndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="script.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="all-classes-index-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "./";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="overview-tree.html">Tree</a></li>
|
|
||||||
<li><a href="index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="help-doc.html#all-classes">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
|
|
||||||
</div>
|
|
||||||
<div id="all-classes-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button></div>
|
|
||||||
<div id="all-classes-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0">
|
|
||||||
<div class="table-header col-first">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">IMU Swerve class for the <code>ADIS16448_IMU</code> device.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">IMU Swerve class for the <code>ADIS16470_IMU</code> device.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">IMU Swerve class for the <code>ADXRS450_Gyro</code> device.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Class for managing persistent alerts to be sent over NetworkTables.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
|
|
||||||
<div class="block">Represents an alert's level of urgency.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Sendable alert for advantage scope.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Creates a IMU for <code>AnalogGyro</code> devices, only uses yaw.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/AngleConversionFactorsJson.html" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Angle motor conversion factors composite JSON parse class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/BoolMotorJson.html" title="class in swervelib.parser.json.modules">BoolMotorJson</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Inverted motor JSON parsed class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="swervelib/parser/Cache.html" title="type parameter in Cache">T</a>></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Cache for frequently requested data.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">SwerveIMU interface for the Boron Candandgyro by Redux Robotics</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">HELIUM <code>Canandmag</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ControllerPropertiesJson.html" title="class in swervelib.parser.json">ControllerPropertiesJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><a href="swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> parsed class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/ConversionFactorsJson.html" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Conversion Factors parsed JSON class</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Device JSON parsed class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/DriveConversionFactorsJson.html" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Drive motor composite JSON parse class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/IMULinearMovingAverageFilter.html" title="class in swervelib.math">IMULinearMovingAverageFilter</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">A linear filter that does not calculate() each time a value is added to
|
|
||||||
the DoubleCircularBuffer.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Generic IMU Velocity filter.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Location JSON parsed class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Object with significant mass that needs to be taken into account.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> JSON parsed class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Used to store doubles for motor configuration.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Used to store ints for motor configuration.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Communicates with the NavX as the IMU.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser"><code>SwerveModulePhysicalCharacteristics</code></a> parsed data.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">SwerveIMU interface for the Pigeon2</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">SwerveIMU interface for the Pigeon.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
|
|
||||||
Encoder." attached via a PWM lane.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">An implementation of <code>CANSparkFlex</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab3">
|
|
||||||
<div class="block">REV Slots for PID configuration.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Brushed motor control with SparkMax.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
|
|
||||||
<div class="block">REV Slots for PID configuration.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Controller class used to convert raw inputs into robot speeds.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve Drive class representing and controlling the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve drive configurations used during SwerveDrive construction.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> JSON parsed class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab3">
|
|
||||||
<div class="block">Verbosity of telemetry data sent back.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Class to perform tests on the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/imu/SwerveIMU.html" title="class in swervelib.imu">SwerveIMU</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve IMU abstraction to define a standard interface with a swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Simulation for <a href="swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Mathematical functions which pertain to swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Configuration class which stores physical characteristics shared between every swerve module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Class to hold simulation data for <a href="swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Swerve motor abstraction which defines a standard interface for motors within a swerve module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block">Helper class used to parse the JSON directory with specified configuration options.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><code>TalonFX</code> Swerve Motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
|
|
||||||
<div class="block"><code>WPI_TalonSRX</code> Swerve Motor.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>All Packages</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="package index">
|
|
||||||
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="script.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="all-packages-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><a href="index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="help-doc.html#all-packages">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="All&nbsp;Packages" class="title">All Packages</h1>
|
|
||||||
</div>
|
|
||||||
<div class="caption"><span>Package Summary</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Package</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><a href="swervelib/package-summary.html">swervelib</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><a href="swervelib/encoders/package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><a href="swervelib/imu/package-summary.html">swervelib.imu</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><a href="swervelib/math/package-summary.html">swervelib.math</a></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Mathematics for swerve drives.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><a href="swervelib/motors/package-summary.html">swervelib.motors</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><a href="swervelib/parser/package-summary.html">swervelib.parser</a></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><a href="swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Deserialize specific variables for outside the parser.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><a href="swervelib/parser/json/package-summary.html">swervelib.parser.json</a></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><a href="swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">JSON Mapped Configuration types for modules.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><a href="swervelib/simulation/package-summary.html">swervelib.simulation</a></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><a href="swervelib/telemetry/package-summary.html">swervelib.telemetry</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Telemetry package for sending data to NT4 or SmartDashboard.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,124 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Constant Field Values</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="summary of constants">
|
|
||||||
<meta name="generator" content="javadoc/ConstantsSummaryWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="script.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="constants-summary-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "./";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="overview-tree.html">Tree</a></li>
|
|
||||||
<li><a href="index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="help-doc.html#constant-values">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
|
|
||||||
<section class="packages">
|
|
||||||
<h2 title="Contents">Contents</h2>
|
|
||||||
<ul>
|
|
||||||
<li><a href="#swervelib.encoders">swervelib.encoders.*</a></li>
|
|
||||||
<li><a href="#swervelib.motors">swervelib.motors.*</a></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<section class="constants-summary" id="swervelib.encoders">
|
|
||||||
<h2 title="swervelib.encoders">swervelib.encoders.*</h2>
|
|
||||||
<ul class="block-list">
|
|
||||||
<li>
|
|
||||||
<div class="caption"><span>swervelib.encoders.<a href="swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Constant Field</div>
|
|
||||||
<div class="table-header col-last">Value</div>
|
|
||||||
<div class="col-first even-row-color"><code id="swervelib.encoders.SwerveAbsoluteEncoder.maximumRetries">public final int</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="swervelib/encoders/SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a></code></div>
|
|
||||||
<div class="col-last even-row-color"><code>5</code></div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="constants-summary" id="swervelib.motors">
|
|
||||||
<h2 title="swervelib.motors">swervelib.motors.*</h2>
|
|
||||||
<ul class="block-list">
|
|
||||||
<li>
|
|
||||||
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Constant Field</div>
|
|
||||||
<div class="table-header col-last">Value</div>
|
|
||||||
<div class="col-first even-row-color"><code id="swervelib.motors.SwerveMotor.maximumRetries">public final int</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="swervelib/motors/SwerveMotor.html#maximumRetries">maximumRetries</a></code></div>
|
|
||||||
<div class="col-last even-row-color"><code>5</code></div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Constant Field</div>
|
|
||||||
<div class="table-header col-last">Value</div>
|
|
||||||
<div class="col-first even-row-color"><code id="swervelib.motors.TalonFXSwerve.absoluteEncoder">private final boolean</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#absoluteEncoder">absoluteEncoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color"><code>false</code></div>
|
|
||||||
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonFXSwerve.factoryDefaultOccurred">private final boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"><code>false</code></div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<div class="caption"><span>swervelib.motors.<a href="swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Constant Field</div>
|
|
||||||
<div class="table-header col-last">Value</div>
|
|
||||||
<div class="col-first even-row-color"><code id="swervelib.motors.TalonSRXSwerve.absoluteEncoder">private final boolean</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="swervelib/motors/TalonSRXSwerve.html#absoluteEncoder">absoluteEncoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color"><code>false</code></div>
|
|
||||||
<div class="col-first odd-row-color"><code id="swervelib.motors.TalonSRXSwerve.factoryDefaultOccurred">private final boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="swervelib/motors/TalonSRXSwerve.html#factoryDefaultOccurred">factoryDefaultOccurred</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"><code>false</code></div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
swervelib
|
|
||||||
swervelib.encoders
|
|
||||||
swervelib.imu
|
|
||||||
swervelib.math
|
|
||||||
swervelib.motors
|
|
||||||
swervelib.parser
|
|
||||||
swervelib.parser.deserializer
|
|
||||||
swervelib.parser.json
|
|
||||||
swervelib.parser.json.modules
|
|
||||||
swervelib.simulation
|
|
||||||
swervelib.telemetry
|
|
||||||
@@ -1,185 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>Constants.Auton (YAGSL-Example 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="declaration: package: frc.robot, class: Constants, class: Auton">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li>Method</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class Constants.Auton" class="title">Class Constants.Auton</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">frc.robot.Constants.Auton</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Enclosing class:</dt>
|
|
||||||
<dd><a href="Constants.html" title="class in frc.robot">Constants</a></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">Constants.Auton</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>static final <a href="../../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#angleAutoPID" class="member-name-link">angleAutoPID</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
<div class="col-first odd-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#MAX_ACCELERATION" class="member-name-link">MAX_ACCELERATION</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"> </div>
|
|
||||||
<div class="col-first even-row-color"><code>static final <a href="../../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#TranslationPID" class="member-name-link">TranslationPID</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Auton</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="TranslationPID">
|
|
||||||
<h3>TranslationPID</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span> <span class="element-name">TranslationPID</span></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="angleAutoPID">
|
|
||||||
<h3>angleAutoPID</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span> <span class="element-name">angleAutoPID</span></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="MAX_ACCELERATION">
|
|
||||||
<h3>MAX_ACCELERATION</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">MAX_ACCELERATION</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.Auton.MAX_ACCELERATION">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>Auton</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Auton</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,167 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>Constants.Drivebase (YAGSL-Example 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="declaration: package: frc.robot, class: Constants, class: Drivebase">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li>Method</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class Constants.Drivebase" class="title">Class Constants.Drivebase</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">frc.robot.Constants.Drivebase</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Enclosing class:</dt>
|
|
||||||
<dd><a href="Constants.html" title="class in frc.robot">Constants</a></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">Constants.Drivebase</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#WHEEL_LOCK_TIME" class="member-name-link">WHEEL_LOCK_TIME</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Drivebase</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="WHEEL_LOCK_TIME">
|
|
||||||
<h3>WHEEL_LOCK_TIME</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">WHEEL_LOCK_TIME</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.Drivebase.WHEEL_LOCK_TIME">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>Drivebase</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Drivebase</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,218 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>Constants.OperatorConstants (YAGSL-Example 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="declaration: package: frc.robot, class: Constants, class: OperatorConstants">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li>Method</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class Constants.OperatorConstants" class="title">Class Constants.OperatorConstants</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">frc.robot.Constants.OperatorConstants</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Enclosing class:</dt>
|
|
||||||
<dd><a href="Constants.html" title="class in frc.robot">Constants</a></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">Constants.OperatorConstants</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#LEFT_X_DEADBAND" class="member-name-link">LEFT_X_DEADBAND</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
<div class="col-first odd-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#LEFT_Y_DEADBAND" class="member-name-link">LEFT_Y_DEADBAND</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"> </div>
|
|
||||||
<div class="col-first even-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#RIGHT_X_DEADBAND" class="member-name-link">RIGHT_X_DEADBAND</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
<div class="col-first odd-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#TURN_CONSTANT" class="member-name-link">TURN_CONSTANT</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">OperatorConstants</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="LEFT_X_DEADBAND">
|
|
||||||
<h3>LEFT_X_DEADBAND</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">LEFT_X_DEADBAND</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.OperatorConstants.LEFT_X_DEADBAND">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="LEFT_Y_DEADBAND">
|
|
||||||
<h3>LEFT_Y_DEADBAND</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">LEFT_Y_DEADBAND</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.OperatorConstants.LEFT_Y_DEADBAND">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="RIGHT_X_DEADBAND">
|
|
||||||
<h3>RIGHT_X_DEADBAND</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">RIGHT_X_DEADBAND</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.OperatorConstants.RIGHT_X_DEADBAND">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="TURN_CONSTANT">
|
|
||||||
<h3>TURN_CONSTANT</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">TURN_CONSTANT</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.OperatorConstants.TURN_CONSTANT">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>OperatorConstants</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">OperatorConstants</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,216 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>Constants (YAGSL-Example 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="declaration: package: frc.robot, class: Constants">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li>Method</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class Constants" class="title">Class Constants</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">frc.robot.Constants</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Constants</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean constants. This
|
|
||||||
class should not be used for any other purpose. All constants should be declared globally (i.e. public static). Do
|
|
||||||
not put anything functional in this class.
|
|
||||||
|
|
||||||
<p>It is advised to statically import this class (or one of its inner classes) wherever the
|
|
||||||
constants are needed, to reduce verbosity.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="nested-class-summary" id="nested-class-summary">
|
|
||||||
<h2>Nested Class Summary</h2>
|
|
||||||
<div class="caption"><span>Nested Classes</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>static final class </code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="Constants.Auton.html" class="type-name-link" title="class in frc.robot">Constants.Auton</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
<div class="col-first odd-row-color"><code>static final class </code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="Constants.Drivebase.html" class="type-name-link" title="class in frc.robot">Constants.Drivebase</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"> </div>
|
|
||||||
<div class="col-first even-row-color"><code>static class </code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="Constants.OperatorConstants.html" class="type-name-link" title="class in frc.robot">Constants.OperatorConstants</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>static final <a href="../../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#CHASSIS" class="member-name-link">CHASSIS</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
<div class="col-first odd-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#LOOP_TIME" class="member-name-link">LOOP_TIME</a></code></div>
|
|
||||||
<div class="col-last odd-row-color"> </div>
|
|
||||||
<div class="col-first even-row-color"><code>static final double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#ROBOT_MASS" class="member-name-link">ROBOT_MASS</a></code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Constants</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="ROBOT_MASS">
|
|
||||||
<h3>ROBOT_MASS</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">ROBOT_MASS</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.ROBOT_MASS">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="CHASSIS">
|
|
||||||
<h3>CHASSIS</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="../../swervelib/math/Matter.html" title="class in swervelib.math">Matter</a></span> <span class="element-name">CHASSIS</span></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="LOOP_TIME">
|
|
||||||
<h3>LOOP_TIME</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">double</span> <span class="element-name">LOOP_TIME</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#frc.robot.Constants.LOOP_TIME">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>Constants</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Constants</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,137 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>Main (YAGSL-Example 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="declaration: package: frc.robot, class: Main">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li>Constr | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li>Constr | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class Main" class="title">Class Main</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">frc.robot.Main</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Main</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">Do NOT add any static variables to this class, or any initialization at all. Unless you know what you are doing, do
|
|
||||||
not modify this file except to change the parameter class to the startRobot call.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#main(java.lang.String...)" class="member-name-link">main</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... args)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Main initialization function.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="main(java.lang.String...)">
|
|
||||||
<h3>main</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">main</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... args)</span></div>
|
|
||||||
<div class="block">Main initialization function. Do not perform any initialization here.
|
|
||||||
|
|
||||||
<p>If you change your main robot class, change the parameter type.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,375 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>Robot (YAGSL-Example 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="declaration: package: frc.robot, class: Robot">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class Robot" class="title">Class Robot</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj.RobotBase
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj.IterativeRobotBase
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj.TimedRobot
|
|
||||||
<div class="inheritance">frc.robot.Robot</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Robot</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj.TimedRobot</span></div>
|
|
||||||
<div class="block">The VM is configured to automatically run this class, and to call the functions corresponding to each mode, as
|
|
||||||
described in the TimedRobot documentation. If you change the name of this class or the package after creating this
|
|
||||||
project, you must also update the build.gradle file in the project.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj.TimedRobot">Fields inherited from class edu.wpi.first.wpilibj.TimedRobot</h3>
|
|
||||||
<code>kDefaultPeriod</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Robot</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#autonomousInit()" class="member-name-link">autonomousInit</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This autonomous runs the autonomous command selected by your <a href="RobotContainer.html" title="class in frc.robot"><code>RobotContainer</code></a> class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#autonomousPeriodic()" class="member-name-link">autonomousPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called periodically during autonomous.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disabledInit()" class="member-name-link">disabledInit</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called once each time the robot enters Disabled mode.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#disabledPeriodic()" class="member-name-link">disabledPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Robot.html" title="class in frc.robot">Robot</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#robotInit()" class="member-name-link">robotInit</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is run when the robot is first started up and should be used for any initialization code.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#robotPeriodic()" class="member-name-link">robotPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called every 20 ms, no matter the mode.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#simulationInit()" class="member-name-link">simulationInit</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called once when the robot is first started up.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#simulationPeriodic()" class="member-name-link">simulationPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called periodically whilst in simulation.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#teleopInit()" class="member-name-link">teleopInit</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#teleopPeriodic()" class="member-name-link">teleopPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called periodically during operator control.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#testInit()" class="member-name-link">testInit</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#testPeriodic()" class="member-name-link">testPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">This function is called periodically during test mode.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj.TimedRobot">Methods inherited from class edu.wpi.first.wpilibj.TimedRobot</h3>
|
|
||||||
<code>addPeriodic, addPeriodic, close, endCompetition, startCompetition</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj.IterativeRobotBase">Methods inherited from class edu.wpi.first.wpilibj.IterativeRobotBase</h3>
|
|
||||||
<code>autonomousExit, disabledExit, driverStationConnected, enableLiveWindowInTest, getPeriod, isLiveWindowEnabledInTest, loopFunc, setNetworkTablesFlushEnabled, teleopExit, testExit</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj.RobotBase">Methods inherited from class edu.wpi.first.wpilibj.RobotBase</h3>
|
|
||||||
<code>getMainThreadId, getRuntimeType, isAutonomous, isAutonomousEnabled, isDisabled, isEnabled, isReal, isSimulation, isTeleop, isTeleopEnabled, isTest, isTestEnabled, startRobot, suppressExitWarning</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>Robot</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Robot</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getInstance()">
|
|
||||||
<h3>getInstance</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Robot.html" title="class in frc.robot">Robot</a></span> <span class="element-name">getInstance</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="robotInit()">
|
|
||||||
<h3>robotInit</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">robotInit</span>()</div>
|
|
||||||
<div class="block">This function is run when the robot is first started up and should be used for any initialization code.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>robotInit</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="robotPeriodic()">
|
|
||||||
<h3>robotPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">robotPeriodic</span>()</div>
|
|
||||||
<div class="block">This function is called every 20 ms, no matter the mode. Use this for items like diagnostics that you want ran
|
|
||||||
during disabled, autonomous, teleoperated and test.
|
|
||||||
|
|
||||||
<p>This runs after the mode specific periodic functions, but before LiveWindow and
|
|
||||||
SmartDashboard integrated updating.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>robotPeriodic</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="disabledInit()">
|
|
||||||
<h3>disabledInit</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">disabledInit</span>()</div>
|
|
||||||
<div class="block">This function is called once each time the robot enters Disabled mode.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>disabledInit</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="disabledPeriodic()">
|
|
||||||
<h3>disabledPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">disabledPeriodic</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>disabledPeriodic</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="autonomousInit()">
|
|
||||||
<h3>autonomousInit</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">autonomousInit</span>()</div>
|
|
||||||
<div class="block">This autonomous runs the autonomous command selected by your <a href="RobotContainer.html" title="class in frc.robot"><code>RobotContainer</code></a> class.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>autonomousInit</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="autonomousPeriodic()">
|
|
||||||
<h3>autonomousPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">autonomousPeriodic</span>()</div>
|
|
||||||
<div class="block">This function is called periodically during autonomous.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>autonomousPeriodic</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="teleopInit()">
|
|
||||||
<h3>teleopInit</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">teleopInit</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>teleopInit</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="teleopPeriodic()">
|
|
||||||
<h3>teleopPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">teleopPeriodic</span>()</div>
|
|
||||||
<div class="block">This function is called periodically during operator control.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>teleopPeriodic</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="testInit()">
|
|
||||||
<h3>testInit</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">testInit</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>testInit</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="testPeriodic()">
|
|
||||||
<h3>testPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">testPeriodic</span>()</div>
|
|
||||||
<div class="block">This function is called periodically during test mode.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>testPeriodic</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="simulationInit()">
|
|
||||||
<h3>simulationInit</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">simulationInit</span>()</div>
|
|
||||||
<div class="block">This function is called once when the robot is first started up.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>simulationInit</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="simulationPeriodic()">
|
|
||||||
<h3>simulationPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">simulationPeriodic</span>()</div>
|
|
||||||
<div class="block">This function is called periodically whilst in simulation.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>simulationPeriodic</code> in class <code>edu.wpi.first.wpilibj.IterativeRobotBase</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,188 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>RobotContainer (YAGSL-Example 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="declaration: package: frc.robot, class: RobotContainer">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot</a></div>
|
|
||||||
<h1 title="Class RobotContainer" class="title">Class RobotContainer</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">frc.robot.RobotContainer</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RobotContainer</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">This class is where the bulk of the robot should be declared. Since Command-based is a "declarative" paradigm, very
|
|
||||||
little robot logic should actually be handled in the <a href="Robot.html" title="class in frc.robot"><code>Robot</code></a> periodic methods (other than the scheduler calls).
|
|
||||||
Instead, the structure of the robot (including subsystems, commands, and trigger mappings) should be declared here.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RobotContainer</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">The container for the robot.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.wpilibj2.command.Command</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAutonomousCommand()" class="member-name-link">getAutonomousCommand</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Use this to pass the autonomous command to the main <a href="Robot.html" title="class in frc.robot"><code>Robot</code></a> class.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMode()" class="member-name-link">setDriveMode</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean brake)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>RobotContainer</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">RobotContainer</span>()</div>
|
|
||||||
<div class="block">The container for the robot. Contains subsystems, OI devices, and commands.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAutonomousCommand()">
|
|
||||||
<h3>getAutonomousCommand</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.wpilibj2.command.Command</span> <span class="element-name">getAutonomousCommand</span>()</div>
|
|
||||||
<div class="block">Use this to pass the autonomous command to the main <a href="Robot.html" title="class in frc.robot"><code>Robot</code></a> class.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>the command to run in autonomous</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setDriveMode()">
|
|
||||||
<h3>setDriveMode</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDriveMode</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setMotorBrake(boolean)">
|
|
||||||
<h3>setMotorBrake</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMotorBrake</span><wbr><span class="parameters">(boolean brake)</span></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,257 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>AutoBalanceCommand (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.auto, class: AutoBalanceCommand">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../../../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../../../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot.commands.swervedrive.auto</a></div>
|
|
||||||
<h1 title="Class AutoBalanceCommand" class="title">Class AutoBalanceCommand</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj2.command.Command
|
|
||||||
<div class="inheritance">frc.robot.commands.swervedrive.auto.AutoBalanceCommand</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AutoBalanceCommand</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
|
|
||||||
<div class="block">Auto Balance command using a simple PID controller. Created by Team 3512
|
|
||||||
<a href="https://github.com/frc3512/Robot-2023/blob/main/src/main/java/frc3512/robot/commands/AutoBalance.java">...</a></div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="nested-class-summary" id="nested-class-summary">
|
|
||||||
<h2>Nested Class Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command</h2>
|
|
||||||
<code>edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>m_requirements</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(frc.robot.subsystems.swervedrive.SwerveSubsystem)" class="member-name-link">AutoBalanceCommand</a><wbr>(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerveSubsystem)</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end(boolean)" class="member-name-link">end</a><wbr>(boolean interrupted)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">The action to take when the command ends.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">The main body of a command.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">The initial subroutine of a command.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">
|
|
||||||
Returns whether this command has finished.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(frc.robot.subsystems.swervedrive.SwerveSubsystem)">
|
|
||||||
<h3>AutoBalanceCommand</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AutoBalanceCommand</span><wbr><span class="parameters">(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerveSubsystem)</span></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="initialize()">
|
|
||||||
<h3>initialize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span>()</div>
|
|
||||||
<div class="block">The initial subroutine of a command. Called once when the command is initially scheduled.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>initialize</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="execute()">
|
|
||||||
<h3>execute</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>()</div>
|
|
||||||
<div class="block">The main body of a command. Called repeatedly while the command is scheduled. (That is, it is called repeatedly
|
|
||||||
until <a href="#isFinished()"><code>isFinished()</code></a>) returns true.)</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>execute</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="isFinished()">
|
|
||||||
<h3>isFinished</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFinished</span>()</div>
|
|
||||||
<div class="block"><p>
|
|
||||||
Returns whether this command has finished. Once a command finishes -- indicated by this method returning true --
|
|
||||||
the scheduler will call its <a href="#end(boolean)"><code>end(boolean)</code></a> method.
|
|
||||||
</p><p>
|
|
||||||
Returning false will result in the command never ending automatically. It may still be cancelled manually or
|
|
||||||
interrupted by another command. Hard coding this command to always return true will result in the command executing
|
|
||||||
once and finishing immediately. It is recommended to use *
|
|
||||||
<code>InstantCommand</code> for such an operation.
|
|
||||||
</p></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>isFinished</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>whether this command has finished.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="end(boolean)">
|
|
||||||
<h3>end</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">end</span><wbr><span class="parameters">(boolean interrupted)</span></div>
|
|
||||||
<div class="block">The action to take when the command ends. Called when either the command finishes normally -- that is it is called
|
|
||||||
when <a href="#isFinished()"><code>isFinished()</code></a> returns true -- or when it is interrupted/canceled. This is where you may want to wrap
|
|
||||||
up loose ends, like shutting off a motor that was being used in the command.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>end</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>interrupted</code> - whether the command was interrupted/canceled</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot.commands.swervedrive.auto (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.auto">
|
|
||||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../../../../";
|
|
||||||
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 class="nav-bar-cell1-rev">Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#package">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Package: </li>
|
|
||||||
<li>Description | </li>
|
|
||||||
<li>Related Packages | </li>
|
|
||||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="Package frc.robot.commands.swervedrive.auto" class="title">Package frc.robot.commands.swervedrive.auto</h1>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<div class="package-signature">package <span class="element-name">frc.robot.commands.swervedrive.auto</span></div>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<li>
|
|
||||||
<div id="class-summary">
|
|
||||||
<div class="caption"><span>Classes</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AutoBalanceCommand.html" title="class in frc.robot.commands.swervedrive.auto">AutoBalanceCommand</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">Auto Balance command using a simple PID controller.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot.commands.swervedrive.auto Class Hierarchy (YAGSL-Example 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="tree: package: frc.robot.commands.swervedrive.auto">
|
|
||||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-tree-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><a href="package-summary.html">Package</a></li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li class="nav-bar-cell1-rev">Tree</li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#tree">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 class="title">Hierarchy For Package frc.robot.commands.swervedrive.auto</h1>
|
|
||||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
|
||||||
<ul class="horizontal">
|
|
||||||
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">edu.wpi.first.wpilibj2.command.Command (implements edu.wpi.first.util.sendable.Sendable)
|
|
||||||
<ul>
|
|
||||||
<li class="circle">frc.robot.commands.swervedrive.auto.<a href="AutoBalanceCommand.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.auto">AutoBalanceCommand</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,258 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>AbsoluteDrive (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.drivebase, class: AbsoluteDrive">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../../../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../../../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot.commands.swervedrive.drivebase</a></div>
|
|
||||||
<h1 title="Class AbsoluteDrive" class="title">Class AbsoluteDrive</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj2.command.Command
|
|
||||||
<div class="inheritance">frc.robot.commands.swervedrive.drivebase.AbsoluteDrive</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AbsoluteDrive</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
|
|
||||||
<div class="block">An example command that uses an example subsystem.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="nested-class-summary" id="nested-class-summary">
|
|
||||||
<h2>Nested Class Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command</h2>
|
|
||||||
<code>edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>m_requirements</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier)" class="member-name-link">AbsoluteDrive</a><wbr>(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> headingHorizontal,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> headingVertical)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Used to drive a swerve robot in full field-centric mode.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end(boolean)" class="member-name-link">end</a><wbr>(boolean interrupted)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier)">
|
|
||||||
<h3>AbsoluteDrive</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbsoluteDrive</span><wbr><span class="parameters">(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> headingHorizontal,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> headingVertical)</span></div>
|
|
||||||
<div class="block">Used to drive a swerve robot in full field-centric mode. vX and vY supply translation inputs, where x is
|
|
||||||
torwards/away from alliance wall and y is left/right. headingHorzontal and headingVertical are the Cartesian
|
|
||||||
coordinates from which the robot's angle will be derived— they will be converted to a polar angle, which the robot
|
|
||||||
will rotate to.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerve</code> - The swerve drivebase subsystem.</dd>
|
|
||||||
<dd><code>vX</code> - DoubleSupplier that supplies the x-translation joystick input. Should be in the range -1
|
|
||||||
to 1 with deadband already accounted for. Positive X is away from the alliance wall.</dd>
|
|
||||||
<dd><code>vY</code> - DoubleSupplier that supplies the y-translation joystick input. Should be in the range -1
|
|
||||||
to 1 with deadband already accounted for. Positive Y is towards the left wall when
|
|
||||||
looking through the driver station glass.</dd>
|
|
||||||
<dd><code>headingHorizontal</code> - DoubleSupplier that supplies the horizontal component of the robot's heading angle. In the
|
|
||||||
robot coordinate system, this is along the same axis as vY. Should range from -1 to 1 with
|
|
||||||
no deadband. Positive is towards the left wall when looking through the driver station
|
|
||||||
glass.</dd>
|
|
||||||
<dd><code>headingVertical</code> - DoubleSupplier that supplies the vertical component of the robot's heading angle. In the
|
|
||||||
robot coordinate system, this is along the same axis as vX. Should range from -1 to 1
|
|
||||||
with no deadband. Positive is away from the alliance wall.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="initialize()">
|
|
||||||
<h3>initialize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>initialize</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="execute()">
|
|
||||||
<h3>execute</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>execute</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="end(boolean)">
|
|
||||||
<h3>end</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">end</span><wbr><span class="parameters">(boolean interrupted)</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>end</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="isFinished()">
|
|
||||||
<h3>isFinished</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFinished</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>isFinished</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,263 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>AbsoluteDriveAdv (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.drivebase, class: AbsoluteDriveAdv">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../../../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../../../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot.commands.swervedrive.drivebase</a></div>
|
|
||||||
<h1 title="Class AbsoluteDriveAdv" class="title">Class AbsoluteDriveAdv</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj2.command.Command
|
|
||||||
<div class="inheritance">frc.robot.commands.swervedrive.drivebase.AbsoluteDriveAdv</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AbsoluteDriveAdv</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
|
|
||||||
<div class="block">A more advanced Swerve Control System that has 4 buttons for which direction to face</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="nested-class-summary" id="nested-class-summary">
|
|
||||||
<h2>Nested Class Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command</h2>
|
|
||||||
<code>edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>m_requirements</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.BooleanSupplier,java.util.function.BooleanSupplier,java.util.function.BooleanSupplier,java.util.function.BooleanSupplier)" class="member-name-link">AbsoluteDriveAdv</a><wbr>(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> headingAdjust,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookAway,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookTowards,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookLeft,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookRight)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Used to drive a swerve robot in full field-centric mode.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end(boolean)" class="member-name-link">end</a><wbr>(boolean interrupted)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.BooleanSupplier,java.util.function.BooleanSupplier,java.util.function.BooleanSupplier,java.util.function.BooleanSupplier)">
|
|
||||||
<h3>AbsoluteDriveAdv</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbsoluteDriveAdv</span><wbr><span class="parameters">(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> headingAdjust,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookAway,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookTowards,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookLeft,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> lookRight)</span></div>
|
|
||||||
<div class="block">Used to drive a swerve robot in full field-centric mode. vX and vY supply translation inputs, where x is
|
|
||||||
torwards/away from alliance wall and y is left/right. Heading Adjust changes the current heading after being
|
|
||||||
multipied by a constant. The look booleans are shortcuts to get the robot to face a certian direction.
|
|
||||||
Based off of ideas in https://www.chiefdelphi.com/t/experiments-with-a-swerve-steering-knob/446172</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerve</code> - The swerve drivebase subsystem.</dd>
|
|
||||||
<dd><code>vX</code> - DoubleSupplier that supplies the x-translation joystick input. Should be in the range -1
|
|
||||||
to 1 with deadband already accounted for. Positive X is away from the alliance wall.</dd>
|
|
||||||
<dd><code>vY</code> - DoubleSupplier that supplies the y-translation joystick input. Should be in the range -1
|
|
||||||
to 1 with deadband already accounted for. Positive Y is towards the left wall when
|
|
||||||
looking through the driver station glass.</dd>
|
|
||||||
<dd><code>headingAdjust</code> - DoubleSupplier that supplies the component of the robot's heading angle that should be adjusted.
|
|
||||||
Should range from -1 to 1 with deadband already accounted for.</dd>
|
|
||||||
<dd><code>lookAway</code> - Face the robot towards the opposing alliance's wall in the same direction the driver is facing</dd>
|
|
||||||
<dd><code>lookTowards</code> - Face the robot towards the driver</dd>
|
|
||||||
<dd><code>lookLeft</code> - Face the robot left</dd>
|
|
||||||
<dd><code>lookRight</code> - Face the robot right</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="initialize()">
|
|
||||||
<h3>initialize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>initialize</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="execute()">
|
|
||||||
<h3>execute</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>execute</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="end(boolean)">
|
|
||||||
<h3>end</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">end</span><wbr><span class="parameters">(boolean interrupted)</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>end</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="isFinished()">
|
|
||||||
<h3>isFinished</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFinished</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>isFinished</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,250 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>AbsoluteFieldDrive (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.drivebase, class: AbsoluteFieldDrive">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../../../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../../../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot.commands.swervedrive.drivebase</a></div>
|
|
||||||
<h1 title="Class AbsoluteFieldDrive" class="title">Class AbsoluteFieldDrive</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj2.command.Command
|
|
||||||
<div class="inheritance">frc.robot.commands.swervedrive.drivebase.AbsoluteFieldDrive</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AbsoluteFieldDrive</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
|
|
||||||
<div class="block">An example command that uses an example subsystem.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="nested-class-summary" id="nested-class-summary">
|
|
||||||
<h2>Nested Class Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command</h2>
|
|
||||||
<code>edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>m_requirements</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier)" class="member-name-link">AbsoluteFieldDrive</a><wbr>(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> heading)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Used to drive a swerve robot in full field-centric mode.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end(boolean)" class="member-name-link">end</a><wbr>(boolean interrupted)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier)">
|
|
||||||
<h3>AbsoluteFieldDrive</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AbsoluteFieldDrive</span><wbr><span class="parameters">(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> heading)</span></div>
|
|
||||||
<div class="block">Used to drive a swerve robot in full field-centric mode. vX and vY supply translation inputs, where x is
|
|
||||||
torwards/away from alliance wall and y is left/right. headingHorzontal and headingVertical are the Cartesian
|
|
||||||
coordinates from which the robot's angle will be derived— they will be converted to a polar angle, which the robot
|
|
||||||
will rotate to.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerve</code> - The swerve drivebase subsystem.</dd>
|
|
||||||
<dd><code>vX</code> - DoubleSupplier that supplies the x-translation joystick input. Should be in the range -1 to 1 with
|
|
||||||
deadband already accounted for. Positive X is away from the alliance wall.</dd>
|
|
||||||
<dd><code>vY</code> - DoubleSupplier that supplies the y-translation joystick input. Should be in the range -1 to 1 with
|
|
||||||
deadband already accounted for. Positive Y is towards the left wall when looking through the driver
|
|
||||||
station glass.</dd>
|
|
||||||
<dd><code>heading</code> - DoubleSupplier that supplies the robot's heading angle.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="initialize()">
|
|
||||||
<h3>initialize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>initialize</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="execute()">
|
|
||||||
<h3>execute</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>execute</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="end(boolean)">
|
|
||||||
<h3>end</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">end</span><wbr><span class="parameters">(boolean interrupted)</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>end</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="isFinished()">
|
|
||||||
<h3>isFinished</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFinished</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>isFinished</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,243 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>TeleopDrive (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.drivebase, class: TeleopDrive">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../../../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../../../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li><a href="#nested-class-summary">Nested</a> | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li>Field | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot.commands.swervedrive.drivebase</a></div>
|
|
||||||
<h1 title="Class TeleopDrive" class="title">Class TeleopDrive</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj2.command.Command
|
|
||||||
<div class="inheritance">frc.robot.commands.swervedrive.drivebase.TeleopDrive</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TeleopDrive</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
|
|
||||||
<div class="block">An example command that uses an example subsystem.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="nested-class-summary" id="nested-class-summary">
|
|
||||||
<h2>Nested Class Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command</h2>
|
|
||||||
<code>edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>m_requirements</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.BooleanSupplier)" class="member-name-link">TeleopDrive</a><wbr>(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> omega,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> driveMode)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Creates a new ExampleCommand.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end(boolean)" class="member-name-link">end</a><wbr>(boolean interrupted)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class edu.wpi.first.wpilibj2.command.Command</h3>
|
|
||||||
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(frc.robot.subsystems.swervedrive.SwerveSubsystem,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.DoubleSupplier,java.util.function.BooleanSupplier)">
|
|
||||||
<h3>TeleopDrive</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">TeleopDrive</span><wbr><span class="parameters">(<a href="../../../subsystems/swervedrive/SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a> swerve,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vX,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> vY,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/DoubleSupplier.html" title="class or interface in java.util.function" class="external-link">DoubleSupplier</a> omega,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/BooleanSupplier.html" title="class or interface in java.util.function" class="external-link">BooleanSupplier</a> driveMode)</span></div>
|
|
||||||
<div class="block">Creates a new ExampleCommand.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerve</code> - The subsystem used by this command.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="initialize()">
|
|
||||||
<h3>initialize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initialize</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>initialize</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="execute()">
|
|
||||||
<h3>execute</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">execute</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>execute</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="end(boolean)">
|
|
||||||
<h3>end</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">end</span><wbr><span class="parameters">(boolean interrupted)</span></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>end</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="isFinished()">
|
|
||||||
<h3>isFinished</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isFinished</span>()</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Overrides:</dt>
|
|
||||||
<dd><code>isFinished</code> in class <code>edu.wpi.first.wpilibj2.command.Command</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot.commands.swervedrive.drivebase (YAGSL-Example 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="declaration: package: frc.robot.commands.swervedrive.drivebase">
|
|
||||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../../../../";
|
|
||||||
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 class="nav-bar-cell1-rev">Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#package">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Package: </li>
|
|
||||||
<li>Description | </li>
|
|
||||||
<li>Related Packages | </li>
|
|
||||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="Package frc.robot.commands.swervedrive.drivebase" class="title">Package frc.robot.commands.swervedrive.drivebase</h1>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<div class="package-signature">package <span class="element-name">frc.robot.commands.swervedrive.drivebase</span></div>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<li>
|
|
||||||
<div id="class-summary">
|
|
||||||
<div class="caption"><span>Classes</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbsoluteDrive.html" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDrive</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">An example command that uses an example subsystem.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="AbsoluteDriveAdv.html" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDriveAdv</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">A more advanced Swerve Control System that has 4 buttons for which direction to face</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AbsoluteFieldDrive.html" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteFieldDrive</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">An example command that uses an example subsystem.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="TeleopDrive.html" title="class in frc.robot.commands.swervedrive.drivebase">TeleopDrive</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">An example command that uses an example subsystem.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot.commands.swervedrive.drivebase Class Hierarchy (YAGSL-Example 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="tree: package: frc.robot.commands.swervedrive.drivebase">
|
|
||||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-tree-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><a href="package-summary.html">Package</a></li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li class="nav-bar-cell1-rev">Tree</li>
|
|
||||||
<li><a href="../../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../../help-doc.html#tree">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 class="title">Hierarchy For Package frc.robot.commands.swervedrive.drivebase</h1>
|
|
||||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
|
||||||
<ul class="horizontal">
|
|
||||||
<li><a href="../../../../../overview-tree.html">All Packages</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">edu.wpi.first.wpilibj2.command.Command (implements edu.wpi.first.util.sendable.Sendable)
|
|
||||||
<ul>
|
|
||||||
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="AbsoluteDrive.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDrive</a></li>
|
|
||||||
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="AbsoluteDriveAdv.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteDriveAdv</a></li>
|
|
||||||
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="AbsoluteFieldDrive.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">AbsoluteFieldDrive</a></li>
|
|
||||||
<li class="circle">frc.robot.commands.swervedrive.drivebase.<a href="TeleopDrive.html" class="type-name-link" title="class in frc.robot.commands.swervedrive.drivebase">TeleopDrive</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,102 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot (YAGSL-Example 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="declaration: package: frc.robot">
|
|
||||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../";
|
|
||||||
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 class="nav-bar-cell1-rev">Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Package: </li>
|
|
||||||
<li>Description | </li>
|
|
||||||
<li>Related Packages | </li>
|
|
||||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="Package frc.robot" class="title">Package frc.robot</h1>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<div class="package-signature">package <span class="element-name">frc.robot</span></div>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<li>
|
|
||||||
<div id="class-summary">
|
|
||||||
<div class="caption"><span>Classes</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Constants.html" title="class in frc.robot">Constants</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean constants.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Constants.Auton.html" title="class in frc.robot">Constants.Auton</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Constants.Drivebase.html" title="class in frc.robot">Constants.Drivebase</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Constants.OperatorConstants.html" title="class in frc.robot">Constants.OperatorConstants</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2"> </div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Main.html" title="class in frc.robot">Main</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">Do NOT add any static variables to this class, or any initialization at all.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Robot.html" title="class in frc.robot">Robot</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">The VM is configured to automatically run this class, and to call the functions corresponding to each mode, as
|
|
||||||
described in the TimedRobot documentation.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RobotContainer.html" title="class in frc.robot">RobotContainer</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">This class is where the bulk of the robot should be declared.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot Class Hierarchy (YAGSL-Example 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="tree: package: frc.robot">
|
|
||||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-tree-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><a href="package-summary.html">Package</a></li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li class="nav-bar-cell1-rev">Tree</li>
|
|
||||||
<li><a href="../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#tree">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 class="title">Hierarchy For Package frc.robot</h1>
|
|
||||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
|
||||||
<ul class="horizontal">
|
|
||||||
<li><a href="../../overview-tree.html">All Packages</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">frc.robot.<a href="Constants.html" class="type-name-link" title="class in frc.robot">Constants</a></li>
|
|
||||||
<li class="circle">frc.robot.<a href="Constants.Auton.html" class="type-name-link" title="class in frc.robot">Constants.Auton</a></li>
|
|
||||||
<li class="circle">frc.robot.<a href="Constants.Drivebase.html" class="type-name-link" title="class in frc.robot">Constants.Drivebase</a></li>
|
|
||||||
<li class="circle">frc.robot.<a href="Constants.OperatorConstants.html" class="type-name-link" title="class in frc.robot">Constants.OperatorConstants</a></li>
|
|
||||||
<li class="circle">frc.robot.<a href="Main.html" class="type-name-link" title="class in frc.robot">Main</a></li>
|
|
||||||
<li class="circle">edu.wpi.first.wpilibj.RobotBase (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a>)
|
|
||||||
<ul>
|
|
||||||
<li class="circle">edu.wpi.first.wpilibj.IterativeRobotBase
|
|
||||||
<ul>
|
|
||||||
<li class="circle">edu.wpi.first.wpilibj.TimedRobot
|
|
||||||
<ul>
|
|
||||||
<li class="circle">frc.robot.<a href="Robot.html" class="type-name-link" title="class in frc.robot">Robot</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="circle">frc.robot.<a href="RobotContainer.html" class="type-name-link" title="class in frc.robot">RobotContainer</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,611 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>SwerveSubsystem (YAGSL-Example 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="declaration: package: frc.robot.subsystems.swervedrive, class: SwerveSubsystem">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">frc.robot.subsystems.swervedrive</a></div>
|
|
||||||
<h1 title="Class SwerveSubsystem" class="title">Class SwerveSubsystem</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">edu.wpi.first.wpilibj2.command.SubsystemBase
|
|
||||||
<div class="inheritance">frc.robot.subsystems.swervedrive.SwerveSubsystem</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>All Implemented Interfaces:</dt>
|
|
||||||
<dd><code>edu.wpi.first.util.sendable.Sendable</code>, <code>edu.wpi.first.wpilibj2.command.Subsystem</code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveSubsystem</span>
|
|
||||||
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.SubsystemBase</span></div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#maximumSpeed" class="member-name-link">maximumSpeed</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Maximum speed of the robot in meters per second, used to limit acceleration.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.io.File)" class="member-name-link">SwerveSubsystem</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> directory)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Initialize <a href="../../../../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> with the directory provided.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveSubsystem</a><wbr>(<a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> driveCfg,
|
|
||||||
<a href="../../../../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> controllerCfg)</code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Construct the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addFakeVisionReading()" class="member-name-link">addFakeVisionReading</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Add a fake vision reading for testing purposes.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean)" class="member-name-link">drive</a><wbr>(edu.wpi.first.math.geometry.Translation2d translation,
|
|
||||||
double rotation,
|
|
||||||
boolean fieldRelative)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">The primary method for controlling the drivebase.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#drive(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">drive</a><wbr>(edu.wpi.first.math.kinematics.ChassisSpeeds velocity)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Drive according to the chassis robot oriented velocity.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">driveFieldOriented</a><wbr>(edu.wpi.first.math.kinematics.ChassisSpeeds velocity)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Drive the robot given a chassis field oriented velocity.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.wpilibj2.command.Command</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAutonomousCommand(java.lang.String,boolean)" class="member-name-link">getAutonomousCommand</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pathName,
|
|
||||||
boolean setOdomToStart)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the path follower with events.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFieldVelocity()" class="member-name-link">getFieldVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Gets the current field-relative velocity (x, y and omega) of the robot</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeading()" class="member-name-link">getHeading</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveDriveKinematics</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getKinematics()" class="member-name-link">getKinematics</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the swerve drive kinematics object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Rotation2d</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPitch()" class="member-name-link">getPitch</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Gets the current pitch angle of the robot, as reported by the imu.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.geometry.Pose2d</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPose()" class="member-name-link">getPose</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Gets the current pose (position and rotation) of the robot, as reported by odometry.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRobotVelocity()" class="member-name-link">getRobotVelocity</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Gets the current velocity (x, y and omega) of the robot</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveController()" class="member-name-link">getSwerveController</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the <a href="../../../../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> in the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSwerveDriveConfiguration()" class="member-name-link">getSwerveDriveConfiguration</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the <a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser"><code>SwerveDriveConfiguration</code></a> object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double xInput,
|
|
||||||
double yInput,
|
|
||||||
double headingX,
|
|
||||||
double headingY)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,edu.wpi.first.math.geometry.Rotation2d)" class="member-name-link">getTargetSpeeds</a><wbr>(double xInput,
|
|
||||||
double yInput,
|
|
||||||
edu.wpi.first.math.geometry.Rotation2d angle)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 1 joystick and one angle.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#lock()" class="member-name-link">lock</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Lock the swerve drive to prevent it from moving.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#periodic()" class="member-name-link">periodic</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#postTrajectory(edu.wpi.first.math.trajectory.Trajectory)" class="member-name-link">postTrajectory</a><wbr>(edu.wpi.first.math.trajectory.Trajectory trajectory)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Post the trajectory to the field.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#resetOdometry(edu.wpi.first.math.geometry.Pose2d)" class="member-name-link">resetOdometry</a><wbr>(edu.wpi.first.math.geometry.Pose2d initialHolonomicPose)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Resets odometry to the given pose.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">setChassisSpeeds</a><wbr>(edu.wpi.first.math.kinematics.ChassisSpeeds chassisSpeeds)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set chassis speeds with closed-loop velocity control.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean brake)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets the drive motors to brake/coast mode.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setupPathPlanner()" class="member-name-link">setupPathPlanner</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Setup AutoBuilder for PathPlanner.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#simulationPeriodic()" class="member-name-link">simulationPeriodic</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zeroGyro()" class="member-name-link">zeroGyro</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.SubsystemBase">Methods inherited from class edu.wpi.first.wpilibj2.command.SubsystemBase</h3>
|
|
||||||
<code>addChild, getName, getSubsystem, initSendable, setName, setSubsystem</code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Subsystem">Methods inherited from interface edu.wpi.first.wpilibj2.command.Subsystem</h3>
|
|
||||||
<code>defer, getCurrentCommand, getDefaultCommand, register, removeDefaultCommand, run, runEnd, runOnce, setDefaultCommand, startEnd</code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="maximumSpeed">
|
|
||||||
<h3>maximumSpeed</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">maximumSpeed</span></div>
|
|
||||||
<div class="block">Maximum speed of the robot in meters per second, used to limit acceleration.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(java.io.File)">
|
|
||||||
<h3>SwerveSubsystem</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveSubsystem</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> directory)</span></div>
|
|
||||||
<div class="block">Initialize <a href="../../../../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> with the directory provided.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>directory</code> - Directory of swerve drive config files.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.SwerveControllerConfiguration)">
|
|
||||||
<h3>SwerveSubsystem</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveSubsystem</span><wbr><span class="parameters">(<a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a> driveCfg,
|
|
||||||
<a href="../../../../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> controllerCfg)</span></div>
|
|
||||||
<div class="block">Construct the swerve drive.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>driveCfg</code> - SwerveDriveConfiguration for the swerve.</dd>
|
|
||||||
<dd><code>controllerCfg</code> - Swerve Controller.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setupPathPlanner()">
|
|
||||||
<h3>setupPathPlanner</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setupPathPlanner</span>()</div>
|
|
||||||
<div class="block">Setup AutoBuilder for PathPlanner.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAutonomousCommand(java.lang.String,boolean)">
|
|
||||||
<h3>getAutonomousCommand</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.wpilibj2.command.Command</span> <span class="element-name">getAutonomousCommand</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pathName,
|
|
||||||
boolean setOdomToStart)</span></div>
|
|
||||||
<div class="block">Get the path follower with events.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>pathName</code> - PathPlanner path name.</dd>
|
|
||||||
<dd><code>setOdomToStart</code> - Set the odometry position to the start of the path.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>AutoBuilder.followPath(PathPlannerPath)</code> path command.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="drive(edu.wpi.first.math.geometry.Translation2d,double,boolean)">
|
|
||||||
<h3>drive</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">drive</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Translation2d translation,
|
|
||||||
double rotation,
|
|
||||||
boolean fieldRelative)</span></div>
|
|
||||||
<div class="block">The primary method for controlling the drivebase. Takes a <code>Translation2d</code> and a rotation rate, and
|
|
||||||
calculates and commands module states accordingly. Can use either open-loop or closed-loop velocity control for
|
|
||||||
the wheel velocities. Also has field- and robot-relative modes, which affect how the translation vector is used.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>translation</code> - <code>Translation2d</code> that is the commanded linear velocity of the robot, in meters per
|
|
||||||
second. In robot-relative mode, positive x is torwards the bow (front) and positive y is
|
|
||||||
torwards port (left). In field-relative mode, positive x is away from the alliance wall
|
|
||||||
(field North) and positive y is torwards the left wall when looking through the driver station
|
|
||||||
glass (field West).</dd>
|
|
||||||
<dd><code>rotation</code> - Robot angular rate, in radians per second. CCW positive. Unaffected by field/robot
|
|
||||||
relativity.</dd>
|
|
||||||
<dd><code>fieldRelative</code> - Drive mode. True for field-relative, false for robot-relative.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds)">
|
|
||||||
<h3>driveFieldOriented</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">driveFieldOriented</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.ChassisSpeeds velocity)</span></div>
|
|
||||||
<div class="block">Drive the robot given a chassis field oriented velocity.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>velocity</code> - Velocity according to the field.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="drive(edu.wpi.first.math.kinematics.ChassisSpeeds)">
|
|
||||||
<h3>drive</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">drive</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.ChassisSpeeds velocity)</span></div>
|
|
||||||
<div class="block">Drive according to the chassis robot oriented velocity.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>velocity</code> - Robot oriented <code>ChassisSpeeds</code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="periodic()">
|
|
||||||
<h3>periodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">periodic</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="simulationPeriodic()">
|
|
||||||
<h3>simulationPeriodic</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">simulationPeriodic</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getKinematics()">
|
|
||||||
<h3>getKinematics</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveDriveKinematics</span> <span class="element-name">getKinematics</span>()</div>
|
|
||||||
<div class="block">Get the swerve drive kinematics object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>SwerveDriveKinematics</code> of the swerve drive.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="resetOdometry(edu.wpi.first.math.geometry.Pose2d)">
|
|
||||||
<h3>resetOdometry</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">resetOdometry</span><wbr><span class="parameters">(edu.wpi.first.math.geometry.Pose2d initialHolonomicPose)</span></div>
|
|
||||||
<div class="block">Resets odometry to the given pose. Gyro angle and module positions do not need to be reset when calling this
|
|
||||||
method. However, if either gyro angle or module position is reset, this must be called in order for odometry to
|
|
||||||
keep working.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>initialHolonomicPose</code> - The pose to set the odometry to</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getPose()">
|
|
||||||
<h3>getPose</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.geometry.Pose2d</span> <span class="element-name">getPose</span>()</div>
|
|
||||||
<div class="block">Gets the current pose (position and rotation) of the robot, as reported by odometry.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>The robot's pose</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)">
|
|
||||||
<h3>setChassisSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setChassisSpeeds</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.ChassisSpeeds chassisSpeeds)</span></div>
|
|
||||||
<div class="block">Set chassis speeds with closed-loop velocity control.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>chassisSpeeds</code> - Chassis Speeds to set.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="postTrajectory(edu.wpi.first.math.trajectory.Trajectory)">
|
|
||||||
<h3>postTrajectory</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">postTrajectory</span><wbr><span class="parameters">(edu.wpi.first.math.trajectory.Trajectory trajectory)</span></div>
|
|
||||||
<div class="block">Post the trajectory to the field.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>trajectory</code> - The trajectory to post.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="zeroGyro()">
|
|
||||||
<h3>zeroGyro</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">zeroGyro</span>()</div>
|
|
||||||
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setMotorBrake(boolean)">
|
|
||||||
<h3>setMotorBrake</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMotorBrake</span><wbr><span class="parameters">(boolean brake)</span></div>
|
|
||||||
<div class="block">Sets the drive motors to brake/coast mode.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>brake</code> - True to set motors to brake mode, false for coast.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getHeading()">
|
|
||||||
<h3>getHeading</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">getHeading</span>()</div>
|
|
||||||
<div class="block">Gets the current yaw angle of the robot, as reported by the imu. CCW positive, not wrapped.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>The yaw angle</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getTargetSpeeds(double,double,double,double)">
|
|
||||||
<h3>getTargetSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getTargetSpeeds</span><wbr><span class="parameters">(double xInput,
|
|
||||||
double yInput,
|
|
||||||
double headingX,
|
|
||||||
double headingY)</span></div>
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 2 joysticks. One for speeds in which direction. The other for
|
|
||||||
the angle of the robot.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction.</dd>
|
|
||||||
<dd><code>yInput</code> - Y joystick input for the robot to move in the Y direction.</dd>
|
|
||||||
<dd><code>headingX</code> - X joystick which controls the angle of the robot.</dd>
|
|
||||||
<dd><code>headingY</code> - Y joystick which controls the angle of the robot.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>ChassisSpeeds</code> which can be sent to th Swerve Drive.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getTargetSpeeds(double,double,edu.wpi.first.math.geometry.Rotation2d)">
|
|
||||||
<h3>getTargetSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getTargetSpeeds</span><wbr><span class="parameters">(double xInput,
|
|
||||||
double yInput,
|
|
||||||
edu.wpi.first.math.geometry.Rotation2d angle)</span></div>
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 1 joystick and one angle.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction.</dd>
|
|
||||||
<dd><code>yInput</code> - Y joystick input for the robot to move in the Y direction.</dd>
|
|
||||||
<dd><code>angle</code> - The angle in as a <code>Rotation2d</code>.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>ChassisSpeeds</code> which can be sent to th Swerve Drive.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getFieldVelocity()">
|
|
||||||
<h3>getFieldVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getFieldVelocity</span>()</div>
|
|
||||||
<div class="block">Gets the current field-relative velocity (x, y and omega) of the robot</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>A ChassisSpeeds object of the current field-relative velocity</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getRobotVelocity()">
|
|
||||||
<h3>getRobotVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getRobotVelocity</span>()</div>
|
|
||||||
<div class="block">Gets the current velocity (x, y and omega) of the robot</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>A <code>ChassisSpeeds</code> object of the current velocity</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getSwerveController()">
|
|
||||||
<h3>getSwerveController</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></span> <span class="element-name">getSwerveController</span>()</div>
|
|
||||||
<div class="block">Get the <a href="../../../../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> in the swerve drive.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="../../../../swervelib/SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> from the <a href="../../../../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a>.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getSwerveDriveConfiguration()">
|
|
||||||
<h3>getSwerveDriveConfiguration</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></span> <span class="element-name">getSwerveDriveConfiguration</span>()</div>
|
|
||||||
<div class="block">Get the <a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser"><code>SwerveDriveConfiguration</code></a> object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>The <a href="../../../../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser"><code>SwerveDriveConfiguration</code></a> fpr the current drive.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="lock()">
|
|
||||||
<h3>lock</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">lock</span>()</div>
|
|
||||||
<div class="block">Lock the swerve drive to prevent it from moving.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getPitch()">
|
|
||||||
<h3>getPitch</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.geometry.Rotation2d</span> <span class="element-name">getPitch</span>()</div>
|
|
||||||
<div class="block">Gets the current pitch angle of the robot, as reported by the imu.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>The heading as a <code>Rotation2d</code> angle</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="addFakeVisionReading()">
|
|
||||||
<h3>addFakeVisionReading</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addFakeVisionReading</span>()</div>
|
|
||||||
<div class="block">Add a fake vision reading for testing purposes.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot.subsystems.swervedrive (YAGSL-Example 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="declaration: package: frc.robot.subsystems.swervedrive">
|
|
||||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../../../";
|
|
||||||
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 class="nav-bar-cell1-rev">Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../help-doc.html#package">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Package: </li>
|
|
||||||
<li>Description | </li>
|
|
||||||
<li>Related Packages | </li>
|
|
||||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="Package frc.robot.subsystems.swervedrive" class="title">Package frc.robot.subsystems.swervedrive</h1>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<div class="package-signature">package <span class="element-name">frc.robot.subsystems.swervedrive</span></div>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<li>
|
|
||||||
<div id="class-summary">
|
|
||||||
<div class="caption"><span>Classes</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveSubsystem.html" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2"> </div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) -->
|
|
||||||
<title>frc.robot.subsystems.swervedrive Class Hierarchy (YAGSL-Example 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="tree: package: frc.robot.subsystems.swervedrive">
|
|
||||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../script-dir/jquery-3.6.0.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-tree-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><a href="package-summary.html">Package</a></li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li class="nav-bar-cell1-rev">Tree</li>
|
|
||||||
<li><a href="../../../../index-all.html">Index</a></li>
|
|
||||||
<li><a href="../../../../help-doc.html#tree">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 class="title">Hierarchy For Package frc.robot.subsystems.swervedrive</h1>
|
|
||||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
|
||||||
<ul class="horizontal">
|
|
||||||
<li><a href="../../../../overview-tree.html">All Packages</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">edu.wpi.first.wpilibj2.command.SubsystemBase (implements edu.wpi.first.util.sendable.Sendable, edu.wpi.first.wpilibj2.command.Subsystem)
|
|
||||||
<ul>
|
|
||||||
<li class="circle">frc.robot.subsystems.swervedrive.<a href="SwerveSubsystem.html" class="type-name-link" title="class in frc.robot.subsystems.swervedrive">SwerveSubsystem</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,181 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>API Help</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="help">
|
|
||||||
<meta name="generator" content="javadoc/HelpWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="script.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="help-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "./";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="overview-tree.html">Tree</a></li>
|
|
||||||
<li><a href="index-files/index-1.html">Index</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Help</li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Help: </li>
|
|
||||||
<li><a href="#help-navigation">Navigation</a> | </li>
|
|
||||||
<li><a href="#help-pages">Pages</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<h1 class="title">JavaDoc Help</h1>
|
|
||||||
<ul class="help-toc">
|
|
||||||
<li><a href="#help-navigation">Navigation</a>:
|
|
||||||
<ul class="help-subtoc">
|
|
||||||
<li><a href="#help-search">Search</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li><a href="#help-pages">Kinds of Pages</a>:
|
|
||||||
<ul class="help-subtoc">
|
|
||||||
<li><a href="#overview">Overview</a></li>
|
|
||||||
<li><a href="#package">Package</a></li>
|
|
||||||
<li><a href="#class">Class or Interface</a></li>
|
|
||||||
<li><a href="#doc-file">Other Files</a></li>
|
|
||||||
<li><a href="#tree">Tree (Class Hierarchy)</a></li>
|
|
||||||
<li><a href="#constant-values">Constant Field Values</a></li>
|
|
||||||
<li><a href="#all-packages">All Packages</a></li>
|
|
||||||
<li><a href="#all-classes">All Classes and Interfaces</a></li>
|
|
||||||
<li><a href="#index">Index</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<hr>
|
|
||||||
<div class="sub-title">
|
|
||||||
<h2 id="help-navigation">Navigation</h2>
|
|
||||||
Starting from the <a href="index.html">Overview</a> page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The <a href="index-files/index-1.html">Index</a> and Search box allow you to navigate to specific declarations and summary pages, including: <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>
|
|
||||||
<section class="help-section" id="help-search">
|
|
||||||
<h3>Search</h3>
|
|
||||||
<p>You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:</p>
|
|
||||||
<ul class="help-section-list">
|
|
||||||
<li><code>j.l.obj</code> will match "java.lang.Object"</li>
|
|
||||||
<li><code>InpStr</code> will match "java.io.InputStream"</li>
|
|
||||||
<li><code>HM.cK</code> will match "java.util.HashMap.containsKey(Object)"</li>
|
|
||||||
</ul>
|
|
||||||
<p>Refer to the <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/javadoc-search-spec.html">Javadoc Search Specification</a> for a full description of search features.</p>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<div class="sub-title">
|
|
||||||
<h2 id="help-pages">Kinds of Pages</h2>
|
|
||||||
The following sections describe the different kinds of pages in this collection.
|
|
||||||
<section class="help-section" id="overview">
|
|
||||||
<h3>Overview</h3>
|
|
||||||
<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="package">
|
|
||||||
<h3>Package</h3>
|
|
||||||
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:</p>
|
|
||||||
<ul class="help-section-list">
|
|
||||||
<li>Interfaces</li>
|
|
||||||
<li>Classes</li>
|
|
||||||
<li>Enum Classes</li>
|
|
||||||
<li>Exceptions</li>
|
|
||||||
<li>Errors</li>
|
|
||||||
<li>Annotation Interfaces</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="class">
|
|
||||||
<h3>Class or Interface</h3>
|
|
||||||
<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.</p>
|
|
||||||
<ul class="help-section-list">
|
|
||||||
<li>Class Inheritance Diagram</li>
|
|
||||||
<li>Direct Subclasses</li>
|
|
||||||
<li>All Known Subinterfaces</li>
|
|
||||||
<li>All Known Implementing Classes</li>
|
|
||||||
<li>Class or Interface Declaration</li>
|
|
||||||
<li>Class or Interface Description</li>
|
|
||||||
</ul>
|
|
||||||
<br>
|
|
||||||
<ul class="help-section-list">
|
|
||||||
<li>Nested Class Summary</li>
|
|
||||||
<li>Enum Constant Summary</li>
|
|
||||||
<li>Field Summary</li>
|
|
||||||
<li>Property Summary</li>
|
|
||||||
<li>Constructor Summary</li>
|
|
||||||
<li>Method Summary</li>
|
|
||||||
<li>Required Element Summary</li>
|
|
||||||
<li>Optional Element Summary</li>
|
|
||||||
</ul>
|
|
||||||
<br>
|
|
||||||
<ul class="help-section-list">
|
|
||||||
<li>Enum Constant Details</li>
|
|
||||||
<li>Field Details</li>
|
|
||||||
<li>Property Details</li>
|
|
||||||
<li>Constructor Details</li>
|
|
||||||
<li>Method Details</li>
|
|
||||||
<li>Element Details</li>
|
|
||||||
</ul>
|
|
||||||
<p><span class="help-note">Note:</span> Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.</p>
|
|
||||||
<p>The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.</p>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="doc-file">
|
|
||||||
<h3>Other Files</h3>
|
|
||||||
<p>Packages and modules may contain pages with additional information related to the declarations nearby.</p>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="tree">
|
|
||||||
<h3>Tree (Class Hierarchy)</h3>
|
|
||||||
<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with <code>java.lang.Object</code>. Interfaces do not inherit from <code>java.lang.Object</code>.</p>
|
|
||||||
<ul class="help-section-list">
|
|
||||||
<li>When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.</li>
|
|
||||||
<li>When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="constant-values">
|
|
||||||
<h3>Constant Field Values</h3>
|
|
||||||
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="all-packages">
|
|
||||||
<h3>All Packages</h3>
|
|
||||||
<p>The <a href="allpackages-index.html">All Packages</a> page contains an alphabetic index of all packages contained in the documentation.</p>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="all-classes">
|
|
||||||
<h3>All Classes and Interfaces</h3>
|
|
||||||
<p>The <a href="allclasses-index.html">All Classes and Interfaces</a> page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.</p>
|
|
||||||
</section>
|
|
||||||
<section class="help-section" id="index">
|
|
||||||
<h3>Index</h3>
|
|
||||||
<p>The <a href="index-files/index-1.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as <a href="allpackages-index.html">All Packages</a>, <a href="allclasses-index.html">All Classes and Interfaces</a>.</p>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<span class="help-footnote">This help file applies to API documentation generated by the standard doclet.</span></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
2886
docs/index-all.html
@@ -1,337 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>A-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: A">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:A">A</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Absolute encoder attached to the SparkMax (if exists)</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Whether the absolute encoder is integrated.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The Absolute Encoder for the swerve module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#absoluteEncoder" class="member-name-link">absoluteEncoder</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Absolute encoder for swerve drive.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Absolute encoder inversion state.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#absoluteEncoderInverted" class="member-name-link">absoluteEncoderInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Whether the absolute encoder is inverted.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#absoluteEncoderIssueName" class="member-name-link">absoluteEncoderIssueName</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NT3 Absolute encoder read issue.</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/motors/SparkFlexSwerve.html#absoluteEncoderOffsetWarning" class="member-name-link">absoluteEncoderOffsetWarning</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder's offset is set in the json instead of the hardware client.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#absolutePositionCache" class="member-name-link">absolutePositionCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Absolute encoder position cache.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#active" class="member-name-link">active</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Activation state of alert.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#activeStartTime" class="member-name-link">activeStartTime</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">When the alert was raised.</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/math/IMULinearMovingAverageFilter.html#addValue(double)" class="member-name-link">addValue(double)</a> - Method in class swervelib.math.<a href="../swervelib/math/IMULinearMovingAverageFilter.html" title="class in swervelib.math">IMULinearMovingAverageFilter</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Add a value to the DoubleCircularBuffer</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#addVisionMeasurement(edu.wpi.first.math.geometry.Pose2d,double)" class="member-name-link">addVisionMeasurement(Pose2d, 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,edu.wpi.first.math.Matrix)" class="member-name-link">addVisionMeasurement(Pose2d, double, 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/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/SwerveModule.html#adjAbsoluteAngleName" class="member-name-link">adjAbsoluteAngleName</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NT3 Adjusted Absolute angle publisher for the absolute encoder.</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/telemetry/Alert.html" class="type-name-link" title="class in swervelib.telemetry">Alert</a> - Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Class for managing persistent alerts to be sent over NetworkTables.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#%3Cinit%3E(java.lang.String,java.lang.String,swervelib.telemetry.Alert.AlertType)" class="member-name-link">Alert(String, String, Alert.AlertType)</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Creates a new Alert.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#%3Cinit%3E(java.lang.String,swervelib.telemetry.Alert.AlertType)" class="member-name-link">Alert(String, Alert.AlertType)</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Creates a new Alert in the default group - "Alerts".</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html" class="type-name-link" title="enum class in swervelib.telemetry">Alert.AlertType</a> - Enum Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Represents an alert's level of urgency.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html" class="type-name-link" title="class in swervelib.telemetry">Alert.SendableAlerts</a> - Class in <a href="../swervelib/telemetry/package-summary.html">swervelib.telemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sendable alert for advantage scope.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html#alerts" class="member-name-link">alerts</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Alert list for sendable.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#%3Cinit%3E()" class="member-name-link">AlertType()</a> - Constructor for enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd> </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/modules/ConversionFactorsJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/ConversionFactorsJson.html" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angle motor conversion factors composition.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The PIDF with Integral Zone used for the angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#angle" class="member-name-link">angle</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Heading of the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angle motor conversion factors composite JSON parse class.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html#%3Cinit%3E()" class="member-name-link">AngleConversionFactorsJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a></dt>
|
|
||||||
<dd> </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/SwerveDriveTest.html#angleModules(swervelib.SwerveDrive,edu.wpi.first.math.geometry.Rotation2d)" class="member-name-link">angleModules(SwerveDrive, Rotation2d)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the angle of the modules to a given <code>Rotation2d</code></div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#angleMotor" class="member-name-link">angleMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve Motors.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorCurrentLimit" class="member-name-link">angleMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Current limits for the Swerve Module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleMotorInverted" class="member-name-link">angleMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">State of inversion of the angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#angleMotorRampRate" class="member-name-link">angleMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angle offset in degrees for the Swerve Module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#angleOffset" class="member-name-link">angleOffset</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angle offset from the absolute encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#anglePIDF" class="member-name-link">anglePIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">PIDF configuration options for the angle motor closed-loop PID controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#angularVelocityCoefficient" class="member-name-link">angularVelocityCoefficient</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Angular Velocity Correction Coefficent (expected values between -0.15 and 0.15).</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#angularVelocityCorrection" class="member-name-link">angularVelocityCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Correct for skew that scales with angular 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></div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#angularVelocitySkewCorrection(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">angularVelocitySkewCorrection(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Correct for skew that worsens as angular velocity increases</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#antiJitter(edu.wpi.first.math.kinematics.SwerveModuleState,edu.wpi.first.math.kinematics.SwerveModuleState,double)" class="member-name-link">antiJitter(SwerveModuleState, SwerveModuleState, 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/SwerveModule.html#antiJitterEnabled" class="member-name-link">antiJitterEnabled</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Anti-Jitter AKA auto-centering disabled.</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/SwerveDrive.html#attainableMaxRotationalVelocityRadiansPerSecond" class="member-name-link">attainableMaxRotationalVelocityRadiansPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The absolute max speed the robot can reach while rotating radians per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#attainableMaxTranslationalSpeedMetersPerSecond" class="member-name-link">attainableMaxTranslationalSpeedMetersPerSecond</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The absolute max speed that your robot can reach while translating in meters per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#autonomousAngularVelocityCorrection" class="member-name-link">autonomousAngularVelocityCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Correct for skew that scales with angular velocity in <a href="../swervelib/SwerveDrive.html#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)"><code>SwerveDrive.setChassisSpeeds(ChassisSpeeds chassisSpeeds)</code></a>
|
|
||||||
during auto.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#autonomousChassisVelocityCorrection" class="member-name-link">autonomousChassisVelocityCorrection</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#setChassisSpeeds(edu.wpi.first.math.kinematics.ChassisSpeeds)"><code>SwerveDrive.setChassisSpeeds(ChassisSpeeds chassisSpeeds)</code></a> (auto) using 254's
|
|
||||||
correction during auto.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>K-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: K">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:K">K</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#kinematics" class="member-name-link">kinematics</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve Kinematics object.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,133 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>L-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: L">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:L">L</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/SwerveController.html#lastAngleScalar" class="member-name-link">lastAngleScalar</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Last angle as a scalar [-1,1] the robot was set to.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#lastHeadingRadians" class="member-name-link">lastHeadingRadians</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The last heading set in radians.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#lastState" class="member-name-link">lastState</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Last swerve module state applied.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#lastTime" class="member-name-link">lastTime</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The last time the timer was read, used to determine position changes.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#lastTime" class="member-name-link">lastTime</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Last time queried.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#left" class="member-name-link">left</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Location of the swerve module in inches from the center of the robot vertically.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#limitVelocity(edu.wpi.first.math.geometry.Translation2d,edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Pose2d,double,double,java.util.List,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">limitVelocity(Translation2d, ChassisSpeeds, Pose2d, double, double, List<Matter>, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Limits a commanded velocity to prevent exceeding the maximum acceleration given by <a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)"><code>SwerveMath.calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration)</code></a>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#location" class="member-name-link">location</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/ModuleJson.html" title="class in swervelib.parser.json">ModuleJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The location of the swerve module from the center of the robot in inches.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Location JSON parsed class.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#%3Cinit%3E()" class="member-name-link">LocationJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#lockPose()" class="member-name-link">lockPose()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Point all modules toward the robot center, thus making the robot very difficult to move.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#logAngularMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logAngularMotorActivity(SwerveModule, SysIdRoutineLog, Supplier<Double>)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#logAngularMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorDutyCycle(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#logAngularMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorVoltage(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#logDriveMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logDriveMotorActivity(SwerveModule, SysIdRoutineLog, Supplier<Double>)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Logs power, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#logDriveMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorDutyCycle(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Logs output, position and velocuty info form the drive motor to the SysIdRoutineLog <br/> Although SysIdRoutine
|
|
||||||
expects to be logging Voltage, this function logs in Duty-Cycle (percent output) because it results in correctly
|
|
||||||
adjusted values in the analysis for use in this library.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#logDriveMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorVoltage(SwerveModule, SysIdRoutineLog)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Logs voltage, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#LOW" class="member-name-link">LOW</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Low telemetry data, only post the robot position on the field.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,259 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>M-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: M">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:M">M</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_anglePosition" class="member-name-link">m_anglePosition</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the rotations of an angular motor</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#m_angleVoltageSetter" class="member-name-link">m_angleVoltageSetter</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Motion magic angle voltage setter.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_angVelocity" class="member-name-link">m_angVelocity</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the velocity of an angular motor</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_appliedVoltage" class="member-name-link">m_appliedVoltage</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the voltage being applied to a motor</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_distance" class="member-name-link">m_distance</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the distance travelled of a position motor</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/IMULinearMovingAverageFilter.html#m_inputGain" class="member-name-link">m_inputGain</a> - Variable in class swervelib.math.<a href="../swervelib/math/IMULinearMovingAverageFilter.html" title="class in swervelib.math">IMULinearMovingAverageFilter</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Gain on each reading.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/IMULinearMovingAverageFilter.html#m_inputs" class="member-name-link">m_inputs</a> - Variable in class swervelib.math.<a href="../swervelib/math/IMULinearMovingAverageFilter.html" title="class in swervelib.math">IMULinearMovingAverageFilter</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Circular buffer storing the current IMU readings</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#m_velocity" class="member-name-link">m_velocity</a> - Static variable in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the velocity of a positional motor</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#m_velocityVoltageSetter" class="member-name-link">m_velocityVoltageSetter</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Velocity voltage setter for controlling drive motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#MACHINE" class="member-name-link">MACHINE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Only send the machine readable data related to swerve drive.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#magnetFieldLessThanIdeal" class="member-name-link">magnetFieldLessThanIdeal</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</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/encoders/SwerveAbsoluteEncoder.html#maximumRetries" class="member-name-link">maximumRetries</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The maximum amount of times the swerve encoder will attempt to configure itself if failures occur.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#maximumRetries" class="member-name-link">maximumRetries</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The maximum amount of times the swerve motor will attempt to configure a motor if failures occur.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#maxSpeed" class="member-name-link">maxSpeed</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Maximum speed of the drive motors 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/SwerveDrive.html#maxSpeedMPS" class="member-name-link">maxSpeedMPS</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Maximum speed of the robot in meters per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredChassisSpeeds" class="member-name-link">measuredChassisSpeeds</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The maximum achievable angular velocity of the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#measuredStates" class="member-name-link">measuredStates</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An array of rotation and velocity values describing the measured state of each swerve module</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#min" class="member-name-link">min</a> - Variable in class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Minimum value.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveParser.html#moduleConfigs" class="member-name-link">moduleConfigs</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Module number mapped to the JSON name.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#moduleCount" class="member-name-link">moduleCount</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Number of modules on the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#moduleCount" class="member-name-link">moduleCount</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The number of swerve modules</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/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/SwerveDrive.html#moduleSynchronizationCounter" class="member-name-link">moduleSynchronizationCounter</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Counter to synchronize the modules relative encoder with absolute encoder when not moving.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">SparkMAX Instance.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">SparkMAX Instance.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">SparkMAX Instance.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">TalonFX motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#motor" class="member-name-link">motor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">TalonSRX motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Used to store doubles for motor configuration.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#%3Cinit%3E()" class="member-name-link">MotorConfigDouble()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Default constructor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#%3Cinit%3E(double,double)" class="member-name-link">MotorConfigDouble(double, double)</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Default constructor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigInt</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Used to store ints for motor configuration.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#%3Cinit%3E()" class="member-name-link">MotorConfigInt()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Default constructor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#%3Cinit%3E(int,int)" class="member-name-link">MotorConfigInt(int, int)</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Default constructor with values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#movementOptimizations(edu.wpi.first.math.kinematics.ChassisSpeeds,boolean,boolean)" class="member-name-link">movementOptimizations(ChassisSpeeds, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enable desired drive corrections</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>N-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: N">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:N">N</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#name" class="member-name-link">name</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Name for the swerve module for telemetry.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/NavXSwerve.html#navXError" class="member-name-link">navXError</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error instantiating the NavX.</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.I2C.Port)" class="member-name-link">NavXSwerve(I2C.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/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/imu/NavXSwerve.html#%3Cinit%3E(edu.wpi.first.wpilibj.SPI.Port)" class="member-name-link">NavXSwerve(SPI.Port)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Constructor for the NavX swerve.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#noEncoderAlert" class="member-name-link">noEncoderAlert</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#noEncoderDefinedAlert" class="member-name-link">noEncoderDefinedAlert</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the motor has no encoder defined.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#noEncoderWarning" class="member-name-link">noEncoderWarning</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#nominalVoltage" class="member-name-link">nominalVoltage</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Nominal voltage default to use with feedforward.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#NONE" class="member-name-link">NONE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">No telemetry data is sent back.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#normalizeAngle(double)" class="member-name-link">normalizeAngle(double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Normalize an angle to be within 0 to 360.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#notifier" class="member-name-link">notifier</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">WPILib <code>Notifier</code> to keep IMU velocity up to date.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,125 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>O-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: O">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:O">O</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#odometryLock" class="member-name-link">odometryLock</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Odometry lock to ensure thread safety.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#odometryThread" class="member-name-link">odometryThread</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">WPILib <code>Notifier</code> to keep odometry up to date.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The Offset in degrees of the PWM absolute encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the ADIS16448.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the ADIS16470.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the ADXRS450.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the analog gyro.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the Boron Canandgyro.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/NavXSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the NavX.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the Pigeon 2.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#offset" class="member-name-link">offset</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Offset for the Pigeon.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#offsetFailure" class="member-name-link">offsetFailure</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder offset.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveParser.html#openJson(java.io.File)" class="member-name-link">openJson(File)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Open JSON file.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#optimalVoltage" class="member-name-link">optimalVoltage</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 voltage to use for the smart motor voltage compensation, default is 12.</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">The voltage to use for the smart motor voltage compensation.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#output" class="member-name-link">output</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The PIDF output range.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,232 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>P-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: P">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:P">P</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#p" class="member-name-link">p</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Proportional Gain for PID.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#physicalCharacteristics" class="member-name-link">physicalCharacteristics</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Physical characteristics of the swerve drive from physicalproperties.json.</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/motors/SparkFlexSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Closed-loop PID controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Closed-loop PID controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#pid" class="member-name-link">pid</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Closed-loop PID controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Hold the PIDF and Integral Zone values for a PID.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E()" class="member-name-link">PIDFConfig()</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Used when parsing PIDF values from JSON.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double)" class="member-name-link">PIDFConfig(double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double)" class="member-name-link">PIDFConfig(double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double)" class="member-name-link">PIDFConfig(double, double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#%3Cinit%3E(double,double,double,double,double)" class="member-name-link">PIDFConfig(double, double, double, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">PIDF Config constructor to contain the values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveParser.html#pidfPropertiesJson" class="member-name-link">pidfPropertiesJson</a> - Static variable in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Parsed modules/pidfproperties.json</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a> - Class in <a href="../swervelib/parser/json/package-summary.html">swervelib.parser.json</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> PID with Feedforward for the drive motor and angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#%3Cinit%3E()" class="member-name-link">PIDFPropertiesJson()</a> - Constructor for class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a> - Class in <a href="../swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Class to hold the minimum and maximum input or output of the PIDF.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/deserializer/PIDFRange.html#%3Cinit%3E()" class="member-name-link">PIDFRange()</a> - Constructor for class swervelib.parser.deserializer.<a href="../swervelib/parser/deserializer/PIDFRange.html" title="class in swervelib.parser.deserializer">PIDFRange</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html" class="type-name-link" title="class in swervelib.imu">Pigeon2Swerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">SwerveIMU interface for the Pigeon2</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int)" class="member-name-link">Pigeon2Swerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Generate the SwerveIMU for pigeon.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#%3Cinit%3E(int,java.lang.String)" class="member-name-link">Pigeon2Swerve(int, String)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Generate the SwerveIMU for pigeon.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html" class="type-name-link" title="class in swervelib.imu">PigeonSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">SwerveIMU interface for the Pigeon.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#%3Cinit%3E(int)" class="member-name-link">PigeonSwerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Generate the SwerveIMU for pigeon.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#placeInAppropriate0To360Scope(double,double)" class="member-name-link">placeInAppropriate0To360Scope(double, double)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Put an angle within the 360 deg scope of a reference.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#POSE" class="member-name-link">POSE</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">Info level + field info</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/imu/IMUVelocity.html#position" class="member-name-link">position</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the previous loop's position as a Rotation2d.</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/motors/SparkMaxSwerve.html#position" class="member-name-link">position</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Supplier for the position of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Position" class="member-name-link">Position</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Slot 1, used for position PID's.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Position" class="member-name-link">Position</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Slot 1, used for position PID's.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#positionConversionFactor" class="member-name-link">positionConversionFactor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The position conversion factor to convert raw sensor units to Meters Per 100ms, or Ticks to Degrees.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#postTrajectory(edu.wpi.first.math.trajectory.Trajectory)" class="member-name-link">postTrajectory(Trajectory)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Post the trajectory to the field</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#powerAngleMotorsDutyCycle(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotorsDutyCycle(SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Power the angle motors for the swerve drive to a set percentage.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#powerAngleMotorsVoltage(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotorsVoltage(SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Power the angle motors for the swerve drive to a set voltage.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#powerDriveMotorsDutyCycle(swervelib.SwerveDrive,double)" class="member-name-link">powerDriveMotorsDutyCycle(SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Power the drive motors for the swerve drive to a set duty cycle percentage.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#powerDriveMotorsVoltage(swervelib.SwerveDrive,double)" class="member-name-link">powerDriveMotorsVoltage(SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Power the drive motors for the swerve drive to a set voltage.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#printAlert(java.lang.String)" class="member-name-link">printAlert(String)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Print the alert message.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#pushOffsetsToEncoders()" class="member-name-link">pushOffsetsToEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Pushes the Absolute Encoder offsets to the Encoder or Motor Controller, depending on type.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#pushOffsetsToEncoders()" class="member-name-link">pushOffsetsToEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Push absolute encoder offset in the memory of the encoder or controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
|
|
||||||
Encoder." attached via a PWM lane.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#%3Cinit%3E(int)" class="member-name-link">PWMDutyCycleEncoderSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Constructor for the PWM duty cycle encoder.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Q-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: Q">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:Q">Q</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#queueSynchronizeEncoders()" class="member-name-link">queueSynchronizeEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Queue synchronization of the integrated angle encoder with the absolute encoder.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,122 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>R-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: R">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:R">R</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#rampRate" class="member-name-link">rampRate</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The minimum number of seconds to take for the motor to go from 0 to full throttle.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#rawAbsoluteAngleName" class="member-name-link">rawAbsoluteAngleName</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NT3 Raw Absolute Angle publisher for the absolute encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#rawAngleName" class="member-name-link">rawAngleName</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NT3 raw angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#rawDriveName" class="member-name-link">rawDriveName</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NT3 Raw drive motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#rawDriveVelName" class="member-name-link">rawDriveVelName</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NT3 Raw drive motor.</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/encoders/CANCoderSwerve.html#readingFaulty" class="member-name-link">readingFaulty</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#readingIgnored" class="member-name-link">readingIgnored</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</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#resetDriveEncoders()" class="member-name-link">resetDriveEncoders()</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/SwerveDrive.html#restoreInternalOffset()" class="member-name-link">restoreInternalOffset()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Restores Internal YAGSL Encoder offsets and sets the Encoder stored offset back to 0</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#restoreInternalOffset()" class="member-name-link">restoreInternalOffset()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Restore internal offset in YAGSL and either sets absolute encoder offset to 0 or restores old value.</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>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,941 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>S-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: S">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:S">S</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#scaleTranslation(edu.wpi.first.math.geometry.Translation2d,double)" class="member-name-link">scaleTranslation(Translation2d, 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">Scale the <code>Translation2d</code> Polar coordinate magnitude.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html#%3Cinit%3E()" class="member-name-link">SendableAlerts()</a> - Constructor for class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#serialCommsIssueWarning" class="member-name-link">serialCommsIssueWarning</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">NavX serial comm issue.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#set(boolean)" class="member-name-link">set(boolean)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets whether the alert should currently be displayed.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#set(double)" class="member-name-link">set(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the percentage output.</div>
|
|
||||||
</dd>
|
|
||||||
<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/SparkFlexSwerve.html#setAbsoluteEncoder(swervelib.encoders.SwerveAbsoluteEncoder)" class="member-name-link">setAbsoluteEncoder(SwerveAbsoluteEncoder)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</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/encoders/AnalogAbsoluteEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Cannot Set the offset of an Analog Absolute Encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CanAndMagSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Cannot set the offset of the CANandMag.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the Absolute Encoder Offset within the CANcoder's Memory.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the Absolute Encoder Offset inside of the SparkMax's Memory.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset(double)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</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#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setAngleMotorVoltageCompensation(double)" class="member-name-link">setAngleMotorVoltageCompensation(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setAnglePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">setAnglePIDF(PIDFConfig)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the angle/azimuth/steering motor PID</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#setAngleSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive)" class="member-name-link">setAngleSysIdRoutine(SysIdRoutine.Config, SubsystemBase, SwerveDrive)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets up the SysId runner and logger for the angle motors</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setAngularVelocityCompensation(boolean,boolean,double)" class="member-name-link">setAngularVelocityCompensation(boolean, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enables angular velocity skew correction in teleop and/or autonomous
|
|
||||||
and sets the angular velocity coefficient for both modes</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setAntiJitter(boolean)" class="member-name-link">setAntiJitter(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the antiJitter functionality, if true the modules will NOT auto center.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setAutoCenteringModules(boolean)" class="member-name-link">setAutoCenteringModules(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enable auto-centering module wheels.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setChassisDiscretization(boolean,boolean,double)" class="member-name-link">setChassisDiscretization(boolean, boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the Chassis discretization seconds as well as enableing/disabling the Chassis velocity correction in teleop and/or auto</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setChassisDiscretization(boolean,double)" class="member-name-link">setChassisDiscretization(boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the Chassis discretization seconds as well as enableing/disabling the Chassis velocity correction in teleop</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.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setCosineCompensator(boolean)" class="member-name-link">setCosineCompensator(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enable or disable the <a href="../swervelib/parser/SwerveModuleConfiguration.html#useCosineCompensator"><code>SwerveModuleConfiguration.useCosineCompensator</code></a> for all
|
|
||||||
<a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>'s in the swerve drive.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setCurrentLimit(int)" class="member-name-link">setCurrentLimit(int)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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/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(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)" class="member-name-link">setDesiredState(SwerveModuleState, 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#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the conversion factor for the drive motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the conversion factor for the drive motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setDriveMotorVoltageCompensation(double)" class="member-name-link">setDriveMotorVoltageCompensation(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setDrivePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">setDrivePIDF(PIDFConfig)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the drive PIDF values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#setDriveSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive,double)" class="member-name-link">setDriveSysIdRoutine(SysIdRoutine.Config, SubsystemBase, SwerveDrive, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets up the SysId runner and logger for the drive motors</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setEncoderAutoSynchronize(boolean)" class="member-name-link">setEncoderAutoSynchronize(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setEncoderAutoSynchronize(boolean,double)" class="member-name-link">setEncoderAutoSynchronize(boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#setFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">setFeedforward(SimpleMotorFeedforward)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the feedforward attributes to the given parameters.</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/SwerveDrive.html#setHeadingCorrection(boolean)" class="member-name-link">setHeadingCorrection(boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the heading correction capabilities of YAGSL.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setHeadingCorrection(boolean,double)" class="member-name-link">setHeadingCorrection(boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the heading correction capabilities of YAGSL.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the gyro to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/NavXSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/SwerveIMU.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</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 to invert its default direction.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setInverted(boolean)" class="member-name-link">setInverted(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the motor to be inverted.</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/SparkFlexSwerve.html#setLoopRampRate(double)" class="member-name-link">setLoopRampRate(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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/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/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> which is used for the
|
|
||||||
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,edu.wpi.first.math.kinematics.ChassisSpeeds,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState[], ChassisSpeeds, boolean)</code></a> function and
|
|
||||||
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeed(double,boolean,double)" class="member-name-link">setMaximumSpeed(double, boolean, 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/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> which is used for the
|
|
||||||
<a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,edu.wpi.first.math.kinematics.ChassisSpeeds,boolean)"><code>SwerveDrive.setRawModuleStates(SwerveModuleState[], ChassisSpeeds, boolean)</code></a> function and
|
|
||||||
<a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double)"><code>SwerveController.getTargetSpeeds(double, double, double, double, double)</code></a> functions.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setMaximumSpeeds(double,double,double)" class="member-name-link">setMaximumSpeeds(double, double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the maximum speeds for desaturation.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setModuleEncoderAutoSynchronize(boolean,double)" class="member-name-link">setModuleEncoderAutoSynchronize(boolean, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,boolean)" class="member-name-link">setModuleStates(SwerveModuleState[], 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/SparkFlexSwerve.html#setMotorBrake(boolean)" class="member-name-link">setMotorBrake(boolean)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the idle mode.</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/SwerveDrive.html#setOdometryPeriod(double)" class="member-name-link">setOdometryPeriod(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the odometry update period in seconds.</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/CanandgyroSwerve.html#setOffset(edu.wpi.first.math.geometry.Rotation3d)" class="member-name-link">setOffset(Rotation3d)</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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/SparkFlexSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the integrated encoder position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the integrated encoder position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the integrated encoder position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the integrated encoder position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the integrated encoder position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setPosition(double)" class="member-name-link">setPosition(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the integrated encoder position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setRawModuleStates(edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,edu.wpi.first.math.kinematics.ChassisSpeeds,boolean)" class="member-name-link">setRawModuleStates(SwerveModuleState[], ChassisSpeeds, 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/SparkFlexSwerve.html#setReference(double,double)" class="member-name-link">setReference(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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)" 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/SparkFlexSwerve.html#setReference(double,double,double)" class="member-name-link">setReference(double, double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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/telemetry/Alert.html#setText(java.lang.String)" class="member-name-link">setText(String)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Updates current alert text.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#setVisionMeasurementStdDevs(edu.wpi.first.math.Matrix)" class="member-name-link">setVisionMeasurementStdDevs(Matrix<N3, N1>)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Sets the pose estimator's trust of global measurements.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setVoltage(double)" class="member-name-link">setVoltage(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the voltage of the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#setVoltage(double)" class="member-name-link">setVoltage(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 of the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#setVoltage(double)" class="member-name-link">setVoltage(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 of the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#setVoltage(double)" class="member-name-link">setVoltage(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 of the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#setVoltage(double)" class="member-name-link">setVoltage(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 of the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#setVoltage(double)" class="member-name-link">setVoltage(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 of the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#setVoltageCompensation(double)" class="member-name-link">setVoltageCompensation(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</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/SwerveDrive.html#simIMU" class="member-name-link">simIMU</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Simulation of the swerve drive.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#simModule" class="member-name-link">simModule</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Simulated swerve module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Simulation" class="member-name-link">Simulation</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Slot 3, used arbitrarily.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Simulation" class="member-name-link">Simulation</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Slot 3, used arbitrarily.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#sizeFrontBack" class="member-name-link">sizeFrontBack</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The distance between the front and back modules.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#sizeLeftRight" class="member-name-link">sizeLeftRight</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The distance between the left and right modules.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkFlexSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An implementation of <code>CANSparkFlex</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/SparkFlexSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">SparkFlexSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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/SparkFlexSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkFlex,boolean)" class="member-name-link">SparkFlexSwerve(CANSparkFlex, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Initialize the swerve motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a> - Enum Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">REV Slots for PID configuration.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx()</a> - Constructor for enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#%3Cinit%3E()" class="member-name-link">SparkMAX_slotIdx()</a> - Constructor for enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</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 analog pin.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#%3Cinit%3E(swervelib.motors.SwerveMotor,double)" class="member-name-link">SparkMaxAnalogEncoderSwerve(SwerveMotor, double)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Create the <a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data
|
|
||||||
port analog pin.</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.SparkRelativeEncoder.Type,int,boolean)" class="member-name-link">SparkMaxBrushedMotorSwerve(int, boolean, SparkRelativeEncoder.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.SparkRelativeEncoder.Type,int,boolean)" class="member-name-link">SparkMaxBrushedMotorSwerve(CANSparkMax, boolean, SparkRelativeEncoder.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 <a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxEncoderSwerve</code></a> object as a duty cycle from the <code>CANSparkMax</code> motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxSwerve</a> - Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An implementation of <code>CANSparkMax</code> as a <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#%3Cinit%3E(int,boolean)" class="member-name-link">SparkMaxSwerve(int, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Initialize the <a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> as a <code>CANSparkMax</code> connected to a Brushless Motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#%3Cinit%3E(com.revrobotics.CANSparkMax,boolean)" class="member-name-link">SparkMaxSwerve(CANSparkMax, boolean)</a> - Constructor for class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Initialize the swerve motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a> - Enum Class in <a href="../swervelib/motors/package-summary.html">swervelib.motors</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">REV Slots for PID configuration.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#state" class="member-name-link">state</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Current simulated swerve module state.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Static variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Wait time for status frames to show up.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Static variable in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Wait time for status frames to show up.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Static variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Wait time for status frames to show up.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a> - Static variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Wait time for status frames to show up.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#stopOdometryThread()" class="member-name-link">stopOdometryThread()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Stop the odometry thread in favor of manually updating odometry.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#supplier" class="member-name-link">supplier</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Supplier for cached value.</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,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/parser/SwerveControllerConfiguration.html#%3Cinit%3E(swervelib.parser.SwerveDriveConfiguration,swervelib.parser.PIDFConfig,double,double)" class="member-name-link">SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double, 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,double)" class="member-name-link">SwerveDrive(SwerveDriveConfiguration, SwerveControllerConfiguration, double)</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,boolean,edu.wpi.first.math.controller.SimpleMotorFeedforward,swervelib.parser.SwerveModulePhysicalCharacteristics)" class="member-name-link">SwerveDriveConfiguration(SwerveModuleConfiguration[], SwerveIMU, boolean, SimpleMotorFeedforward, SwerveModulePhysicalCharacteristics)</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/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/SwerveDriveTest.html" class="type-name-link" title="class in swervelib">SwerveDriveTest</a> - Class in <a href="../swervelib/package-summary.html">swervelib</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Class to perform tests on the swerve drive.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#%3Cinit%3E()" class="member-name-link">SwerveDriveTest()</a> - Constructor for class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd> </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/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/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,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">SwerveModule(int, SwerveModuleConfiguration, SimpleMotorFeedforward)</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.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,boolean,boolean,boolean,java.lang.String,boolean)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, MotorConfigDouble, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, boolean, boolean, boolean, String, boolean)</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.parser.json.MotorConfigDouble,swervelib.encoders.SwerveAbsoluteEncoder,double,double,double,swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String,boolean)" class="member-name-link">SwerveModuleConfiguration(SwerveMotor, SwerveMotor, MotorConfigDouble, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, SwerveModulePhysicalCharacteristics, String, boolean)</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(swervelib.parser.json.MotorConfigDouble,double,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(MotorConfigDouble, double, 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/parser/SwerveModulePhysicalCharacteristics.html#%3Cinit%3E(swervelib.parser.json.MotorConfigDouble,double,double,int,int,double,double)" class="member-name-link">SwerveModulePhysicalCharacteristics(MotorConfigDouble, double, double, int, int, double, double)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Construct the swerve module physical characteristics.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#swerveModules" class="member-name-link">swerveModules</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve modules.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveModuleSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Class to hold simulation data for <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveModuleSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Create simulation class and initialize module at 0.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/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/SwerveModule.html#synchronizeEncoderDeadband" class="member-name-link">synchronizeEncoderDeadband</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Encoder synchronization deadband in degrees.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#synchronizeEncoderEnabled" class="member-name-link">synchronizeEncoderEnabled</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Encoder, Absolute encoder synchronization enabled.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Encoder synchronization queued.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#synchronizeModuleEncoders()" class="member-name-link">synchronizeModuleEncoders()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Synchronize angle motor integrated encoders with data from absolute encoders.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>T-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: T">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:T">T</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/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.phoenix6.hardware.TalonFX,boolean)" class="member-name-link">TalonFXSwerve(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/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#%3Cinit%3E()" class="member-name-link">TelemetryVerbosity()</a> - Constructor for enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#text" class="member-name-link">text</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Text of the alert.</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/simulation/SwerveIMUSimulation.html#timer" class="member-name-link">timer</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Main timer to control movement estimations.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#timer" class="member-name-link">timer</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Main timer to simulate the passage of time.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#timestamp" class="member-name-link">timestamp</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tracks the previous loop's recorded time.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#timestamp" class="member-name-link">timestamp</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Timestamp in microseconds.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#tunerXRecommendation" class="member-name-link">tunerXRecommendation</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Alert to recommend Tuner X if the configuration is compatible.</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>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#type" class="member-name-link">type</a> - Variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Type of the Alert to raise.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,91 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>B-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: B">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:B">B</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/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/SparkFlexSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#burnFlash()" class="member-name-link">burnFlash()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Save the configurations from flash to EEPROM.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>U-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: U">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:U">U</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#update()" class="member-name-link">update()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Update the robot's rotational velocity based on the current gyro position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#update()" class="member-name-link">update()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Update the cache value and timestamp.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#updateCacheValidityPeriods(long,long,long)" class="member-name-link">updateCacheValidityPeriods(long, long, long)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Update the cache validity period for the robot.</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(edu.wpi.first.math.kinematics.SwerveDriveKinematics,edu.wpi.first.math.kinematics.SwerveModuleState%5B%5D,edu.wpi.first.math.geometry.Pose2d%5B%5D,edu.wpi.first.wpilibj.smartdashboard.Field2d)" class="member-name-link">updateOdometry(SwerveDriveKinematics, SwerveModuleState[], 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(edu.wpi.first.math.kinematics.SwerveModuleState)" class="member-name-link">updateStateAndPosition(SwerveModuleState)</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/parser/Cache.html#updateSupplier(java.util.function.Supplier)" class="member-name-link">updateSupplier(Supplier<T>)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Update the supplier to a new source.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#updateTelemetry()" class="member-name-link">updateTelemetry()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Update data sent to <code>SmartDashboard</code>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#updateValidityPeriod(long)" class="member-name-link">updateValidityPeriod(long)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Update the validity period for the cached value, also updates the value.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#useCosineCompensator" class="member-name-link">useCosineCompensator</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">Should do cosine compensation when not pointing correct direction;.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#useCosineCompensator" class="member-name-link">useCosineCompensator</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Should do cosine compensation when not pointing correct direction;.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,134 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>V-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: V">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:V">V</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#validityPeriod" class="member-name-link">validityPeriod</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Validity period in microseconds.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#value" class="member-name-link">value</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Cached value.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns the enum constant of this class with the specified name.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns an array containing the constants of this enum class, in
|
|
||||||
the order they are declared.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns an array containing the constants of this enum class, in
|
|
||||||
the order they are declared.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns an array containing the constants of this enum class, in
|
|
||||||
the order they are declared.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#values()" class="member-name-link">values()</a> - Static method in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Returns an array containing the constants of this enum class, in
|
|
||||||
the order they are declared.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#velocity" class="member-name-link">velocity</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The calculated velocity of the robot based on averaged IMU measurements.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#velocity" class="member-name-link">velocity</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Supplier for the velocity of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html#Velocity" class="member-name-link">Velocity</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Slot 2, used for velocity PID's.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html#Velocity" class="member-name-link">Velocity</a> - Enum constant in enum class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Slot 2, used for velocity PID's.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#velocityFilter" class="member-name-link">velocityFilter</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Linear filter used to calculate velocity, we use a custom filter class
|
|
||||||
to prevent unwanted operations.</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>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,85 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>W-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: W">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:W">W</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#WARNING" class="member-name-link">WARNING</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Medium priority alert - displayed second on the dashboard with a yellow "!" symbol.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#WARNING_TRACE" class="member-name-link">WARNING_TRACE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Medium priority alert - displayed second on the dashboard with a yellow "!" symbol.</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 Locations of the swerve drive wheels.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveController.html#withinHypotDeadband(double,double)" class="member-name-link">withinHypotDeadband(double, double)</a> - Method in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculate the hypot deadband and check if the joystick is within it.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>X-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: X">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:X">X</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#x" class="member-name-link">x</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Location of the swerve module in inches from the center of the robot horizontally.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveController.html#xLimiter" class="member-name-link">xLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for movement in the X direction in meters/second.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Y-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: Y">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:Y">Y</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#y" class="member-name-link">y</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Location of the swerve module in inches from the center of the robot vertically.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveController.html#yLimiter" class="member-name-link">yLimiter</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for movement in the Y direction in meters/second.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Z-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: Z">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:Z">Z</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#zeroGyro()" class="member-name-link">zeroGyro()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,557 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>C-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: C">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:C">C</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html" class="type-name-link" title="class in swervelib.parser">Cache</a><<a href="../swervelib/parser/Cache.html" title="type parameter in Cache">T</a>> - Class in <a href="../swervelib/parser/package-summary.html">swervelib.parser</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Cache for frequently requested data.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/Cache.html#%3Cinit%3E(java.util.function.Supplier,long)" class="member-name-link">Cache(Supplier<T>, long)</a> - Constructor for class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Cache for arbitrary values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d,java.util.List,double,swervelib.parser.SwerveDriveConfiguration)" class="member-name-link">calcMaxAccel(Rotation2d, List<Matter>, double, SwerveDriveConfiguration)</a> - Static method in class swervelib.math.<a href="../swervelib/math/SwerveMath.html" title="class in swervelib.math">SwerveMath</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculates the maximum acceleration allowed in a direction without tipping the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/IMULinearMovingAverageFilter.html#calculate()" class="member-name-link">calculate()</a> - Method in class swervelib.math.<a href="../swervelib/math/IMULinearMovingAverageFilter.html" title="class in swervelib.math">IMULinearMovingAverageFilter</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculate the average of the samples in the buffer</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html#calculate()" class="member-name-link">calculate()</a> - Method in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculate the drive conversion factor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html#calculate()" class="member-name-link">calculate()</a> - Method in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculate the drive conversion factor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/SwerveMath.html#calculateDegreesPerSteeringRotation(double)" class="member-name-link">calculateDegreesPerSteeringRotation(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#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)" class="member-name-link">calculateMetersPerRotation(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/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/imu/CanandgyroSwerve.html" class="type-name-link" title="class in swervelib.imu">CanandgyroSwerve</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">SwerveIMU interface for the Boron Candandgyro by Redux Robotics</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#%3Cinit%3E(int)" class="member-name-link">CanandgyroSwerve(int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Generate the SwerveIMU for <code>Canandgyro</code>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CanAndMagSwerve.html" class="type-name-link" title="class in swervelib.encoders">CanAndMagSwerve</a> - Class in <a href="../swervelib/encoders/package-summary.html">swervelib.encoders</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">HELIUM <code>Canandmag</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CanAndMagSwerve.html#%3Cinit%3E(int)" class="member-name-link">CanAndMagSwerve(int)</a> - Constructor for class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Create the <code>Canandmag</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/telemetry/SwerveDriveTelemetry.html#canIdWarning" class="member-name-link">canIdWarning</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 <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CAN ID is greater than 40.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#cannotSetOffset" class="member-name-link">cannotSetOffset</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#cannotSetOffset" class="member-name-link">cannotSetOffset</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#centerModules(swervelib.SwerveDrive)" class="member-name-link">centerModules(SwerveDrive)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Set the modules to center to 0.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#cfg" class="member-name-link">cfg</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Pigeon2 configurator.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#cfg" class="member-name-link">cfg</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Current TalonFX Configurator.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#chassisVelocityCorrection" class="member-name-link">chassisVelocityCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Correct chassis velocity in <a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)"><code>SwerveDrive.drive(Translation2d, double, boolean, boolean)</code></a> using 254's
|
|
||||||
correction.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveParser.html#checkDirectory(java.io.File)" class="member-name-link">checkDirectory(File)</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveParser.html" title="class in swervelib.parser">SwerveParser</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Check directory structure.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#checkIfTunerXCompatible()" class="member-name-link">checkIfTunerXCompatible()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Check all components to ensure that Tuner X Swerve Generator is recommended instead.</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/CanAndMagSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</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/PWMDutyCycleEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</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/CanandgyroSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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/SparkFlexSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#clearStickyFaults()" class="member-name-link">clearStickyFaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Clear the sticky faults on the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveController.html#config" class="member-name-link">config</a> - Variable in class swervelib.<a href="../swervelib/SwerveController.html" title="class in swervelib">SwerveController</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
|
|
||||||
robot heading, and deadband for heading joystick.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configChanged" class="member-name-link">configChanged</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">If the TalonFX configuration has changed.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Current TalonFX configuration.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Current TalonFX configuration.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#configuration" class="member-name-link">configuration</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve module configuration options.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CanAndMagSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the CANandMag 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/PWMDutyCycleEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the inversion state of the encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#configure(boolean)" class="member-name-link">configure(boolean)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</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/SparkFlexSwerve.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/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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,int,int)" class="member-name-link">configureCANStatusFrames(int, int, 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/SparkFlexSwerve.html#configureIntegratedEncoder(double)" class="member-name-link">configureIntegratedEncoder(double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the integrated encoder for the swerve module.</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/SparkFlexSwerve.html#configurePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">configurePIDF(PIDFConfig)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the PIDF values for the closed loop controller.</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/SparkFlexSwerve.html#configurePIDWrapping(double,double)" class="member-name-link">configurePIDWrapping(double, double)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the PID wrapping for the position 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/motors/SparkFlexSwerve.html#configureSparkFlex(java.util.function.Supplier)" class="member-name-link">configureSparkFlex(Supplier<REVLibError>)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier<REVLibError>)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier<REVLibError>)</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier<REVLibError>)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax(Supplier<REVLibError>)</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</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#conversionFactor" class="member-name-link">conversionFactor</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Conversion factor for the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#conversionFactor" class="member-name-link">conversionFactor</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">Conversion factor for the module, if different from the one in swervedrive.json</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#conversionFactor" class="member-name-link">conversionFactor</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">Conversion factor applied to the motor controllers PID loops.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#conversionFactor" class="member-name-link">conversionFactor</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 conversion factors for the drive and angle motors, created by
|
|
||||||
<a href="../swervelib/math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a> and
|
|
||||||
<a href="../swervelib/math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#conversionFactors" class="member-name-link">conversionFactors</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">Conversion Factors composition.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#conversionFactors" class="member-name-link">conversionFactors</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">Conversion Factors composition.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#conversionFactors" class="member-name-link">conversionFactors</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Conversion factor for drive motor onboard PID's and angle PID's.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/ConversionFactorsJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Conversion Factors parsed JSON class</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/ConversionFactorsJson.html#%3Cinit%3E()" class="member-name-link">ConversionFactorsJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/ConversionFactorsJson.html" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></dt>
|
|
||||||
<dd> </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/SwerveDriveTest.html#createConfigCustomTimeout(double)" class="member-name-link">createConfigCustomTimeout(double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Creates a SysIdRoutine.Config with a custom final timeout</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ControllerPropertiesJson.html#createControllerConfiguration(swervelib.parser.SwerveDriveConfiguration,double)" class="member-name-link">createControllerConfiguration(SwerveDriveConfiguration, double)</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/math/SwerveMath.html#createDriveFeedforward(double,double,double)" class="member-name-link">createDriveFeedforward(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">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/imu/IMUVelocity.html#createIMUVelocity(swervelib.imu.SwerveIMU)" class="member-name-link">createIMUVelocity(SwerveIMU)</a> - Static method in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Static factory for IMU Velocity.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/ModuleJson.html#createModuleConfiguration(swervelib.parser.PIDFConfig,swervelib.parser.PIDFConfig,swervelib.parser.SwerveModulePhysicalCharacteristics,java.lang.String)" class="member-name-link">createModuleConfiguration(PIDFConfig, PIDFConfig, 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,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">createModules(SwerveModuleConfiguration[], SimpleMotorFeedforward)</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()" class="member-name-link">createPhysicalProperties()</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(double)" class="member-name-link">createSwerveDrive(double)</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/SwerveParser.html#createSwerveDrive(double,double,double)" class="member-name-link">createSwerveDrive(double, double, double)</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/SwerveParser.html#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double)" class="member-name-link">createSwerveDrive(SimpleMotorFeedforward, double)</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/SwerveParser.html#createSwerveDrive(edu.wpi.first.math.controller.SimpleMotorFeedforward,double,double,double)" class="member-name-link">createSwerveDrive(SimpleMotorFeedforward, double, double, double)</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/math/SwerveMath.html#cubeTranslation(edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">cubeTranslation(Translation2d)</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">Cube the <code>Translation2d</code> magnitude given in Polar coordinates.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PhysicalPropertiesJson.html#currentLimit" class="member-name-link">currentLimit</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PhysicalPropertiesJson.html" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The current limit in AMPs to apply to the motors.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,190 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>D-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: D">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:D">D</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#d" class="member-name-link">d</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Derivative Gain for PID.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/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/parser/json/modules/DriveConversionFactorsJson.html#diameter" class="member-name-link">diameter</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Diameter of the wheel in inches.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#discretizationdtSeconds" class="member-name-link">discretizationdtSeconds</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Amount of seconds the duration of the timestep the speeds should be applied for.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#doesNotSupportIntegratedOffsets" class="member-name-link">doesNotSupportIntegratedOffsets</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder does not support integrated offsets.</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/modules/ConversionFactorsJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/ConversionFactorsJson.html" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Drive motor conversion factors composition.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigDouble.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigDouble.html" title="class in swervelib.parser.json">MotorConfigDouble</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Drive motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/MotorConfigInt.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/MotorConfigInt.html" title="class in swervelib.parser.json">MotorConfigInt</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Drive motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/PIDFPropertiesJson.html#drive" class="member-name-link">drive</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/PIDFPropertiesJson.html" title="class in swervelib.parser.json">PIDFPropertiesJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The PIDF with Integral Zone used for the drive motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean)" class="member-name-link">drive(Translation2d, double, boolean, boolean)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The primary method for controlling the drivebase.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.geometry.Translation2d,double,boolean,boolean,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">drive(Translation2d, double, boolean, boolean, Translation2d)</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.kinematics.ChassisSpeeds)" class="member-name-link">drive(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Secondary method for controlling the drivebase.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#drive(edu.wpi.first.math.kinematics.ChassisSpeeds,boolean,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">drive(ChassisSpeeds, boolean, Translation2d)</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.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">drive(ChassisSpeeds, Translation2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Secondary method for controlling the drivebase.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a> - Class in <a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Drive motor composite JSON parse class.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html#%3Cinit%3E()" class="member-name-link">DriveConversionFactorsJson()</a> - Constructor for class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">driveFieldOriented(ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Secondary method of controlling the drive base given velocity and adjusting it for field oriented use.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#driveFieldOriented(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.geometry.Translation2d)" class="member-name-link">driveFieldOriented(ChassisSpeeds, Translation2d)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Secondary method of controlling the drive base given velocity and adjusting it for field oriented use.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#driveFieldOrientedandRobotOriented(edu.wpi.first.math.kinematics.ChassisSpeeds,edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">driveFieldOrientedandRobotOriented(ChassisSpeeds, ChassisSpeeds)</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Tertiary method of controlling the drive base given velocity in both field oriented and robot oriented at the same
|
|
||||||
time.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The drive motor and angle motor of this swerve module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#driveMotor" class="member-name-link">driveMotor</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve Motors.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorCurrentLimit" class="member-name-link">driveMotorCurrentLimit</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Current limits for the Swerve Module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#driveMotorFeedforward" class="member-name-link">driveMotorFeedforward</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Feedforward for the drive motor during closed loop control.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModuleConfiguration.html#driveMotorInverted" class="member-name-link">driveMotorInverted</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">State of inversion of the drive motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html#driveMotorRampRate" class="member-name-link">driveMotorRampRate</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveModulePhysicalCharacteristics.html" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The time it takes for the motor to go from 0 to full throttle in seconds.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#drivePositionCache" class="member-name-link">drivePositionCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Drive motor position cache.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#driveVelocityCache" class="member-name-link">driveVelocityCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Drive motor velocity cache.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#dt" class="member-name-link">dt</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Time delta since last update</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,113 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>E-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: E">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:E">E</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/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/CanAndMagSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The <code>Canandmag</code> representing the CANandMag 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/PWMDutyCycleEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Duty Cycle Encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The <code>SparkAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</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/SparkFlexSwerve.html#encoder" class="member-name-link">encoder</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Integrated encoder.</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/SwerveModule.html#encoderOffsetWarning" class="member-name-link">encoderOffsetWarning</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#ERROR" class="member-name-link">ERROR</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">High priority alert - displayed first on the dashboard with a red "X" symbol.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#ERROR_TRACE" class="member-name-link">ERROR_TRACE</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">High priority alert - displayed first on the dashboard with a red "X" symbol.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,229 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>F-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: F">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:F">F</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#f" class="member-name-link">f</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Feedforward value for PID.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html#factor" class="member-name-link">factor</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculated or given conversion factor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html#factor" class="member-name-link">factor</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculated conversion factor.</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/CanAndMagSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</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/PWMDutyCycleEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</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/CanandgyroSwerve.html#factoryDefault()" class="member-name-link">factoryDefault()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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/SparkFlexSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Factory default already occurred.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Factory default already occurred.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxSwerve.html" title="class in swervelib.motors">SparkMaxSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Factory default already occurred.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonFXSwerve.html" title="class in swervelib.motors">TalonFXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Factory default already occurred.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#factoryDefaultOccurred" class="member-name-link">factoryDefaultOccurred</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/TalonSRXSwerve.html" title="class in swervelib.motors">TalonSRXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Factory default already occurred.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#factoryDefaults()" class="member-name-link">factoryDefaults()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Configure the factory defaults.</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/encoders/SparkMaxAnalogEncoderSwerve.html#failureConfiguring" class="member-name-link">failureConfiguring</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#failureConfiguring" class="member-name-link">failureConfiguring</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#failureConfiguring" class="member-name-link">failureConfiguring</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#failureConfiguringAlert" class="member-name-link">failureConfiguringAlert</a> - Variable in class swervelib.motors.<a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an error configuring the motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#fakePos" class="member-name-link">fakePos</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Fake motor position.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#fakeSpeed" class="member-name-link">fakeSpeed</a> - Variable in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The fake speed of the previous state, used to calculate <a href="../swervelib/simulation/SwerveModuleSimulation.html#fakePos"><code>SwerveModuleSimulation.fakePos</code></a>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/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/SwerveDriveTest.html#findCouplingRatio(swervelib.SwerveDrive,double,boolean)" class="member-name-link">findCouplingRatio(SwerveDrive, double, boolean)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Find the coupling ratio for all modules.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#findDriveMotorKV(swervelib.SwerveDrive,double,double,double)" class="member-name-link">findDriveMotorKV(SwerveDrive, double, double, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Find the minimum amount of power required to move the swerve drive motors.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#firstCycle" class="member-name-link">firstCycle</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Prevents calculation when no previous measurement exists.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#forwardDirection" class="member-name-link">forwardDirection</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.html" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The direction the robot should be facing when the "Robot Rotation" is zero or blank.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/LocationJson.html#front" class="member-name-link">front</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/LocationJson.html" title="class in swervelib.parser.json.modules">LocationJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Location of the swerve module in inches from the center of the robot horizontally.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,669 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>G-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: G">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:G">G</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html#gearRatio" class="member-name-link">gearRatio</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/AngleConversionFactorsJson.html" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Gear ratio for the angle/steering/azimuth motor on the Swerve Module.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html#gearRatio" class="member-name-link">gearRatio</a> - Variable in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/DriveConversionFactorsJson.html" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Gear ratio for the drive motor rotations to turn the wheel 1 complete rotation.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDriveTest.html#generateSysIdCommand(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine,double,double,double)" class="member-name-link">generateSysIdCommand(SysIdRoutine, double, double, double)</a> - Static method in class swervelib.<a href="../swervelib/SwerveDriveTest.html" title="class in swervelib">SwerveDriveTest</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Creates a command that can be mapped to a button or other trigger.</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/CanAndMagSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</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/PWMDutyCycleEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the encoder object.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</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/SwerveModule.html#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the <a href="../swervelib/encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</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#getAbsoluteEncoderReadIssue()" class="member-name-link">getAbsoluteEncoderReadIssue()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get if the last Absolute Encoder had a read issue, such as it does not exist.</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/CanAndMagSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</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/PWMDutyCycleEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#getAbsolutePosition()" class="member-name-link">getAbsolutePosition()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</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/CanandgyroSwerve.html#getAccel()" class="member-name-link">getAccel()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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#getAnglePIDF()" class="member-name-link">getAnglePIDF()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the current angle/azimuth/steering motor PIDF values.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#getAppliedOutput()" class="member-name-link">getAppliedOutput()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the applied dutycycle output.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getAppliedOutput()" class="member-name-link">getAppliedOutput()</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 applied dutycycle output.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getAppliedOutput()" class="member-name-link">getAppliedOutput()</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 applied dutycycle output.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#getAppliedOutput()" class="member-name-link">getAppliedOutput()</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 applied dutycycle output.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getAppliedOutput()" class="member-name-link">getAppliedOutput()</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 applied dutycycle output.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getAppliedOutput()" class="member-name-link">getAppliedOutput()</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 applied dutycycle output.</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#getCosineCompensatedVelocity(edu.wpi.first.math.kinematics.SwerveModuleState)" class="member-name-link">getCosineCompensatedVelocity(SwerveModuleState)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the cosine compensated velocity to set the swerve module to.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#getDriveBaseRadiusMeters()" class="member-name-link">getDriveBaseRadiusMeters()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Calculate the Drive Base Radius</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/SwerveModule.html#getDrivePIDF()" class="member-name-link">getDrivePIDF()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the current drive motor PIDF values.</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/SwerveDrive.html#getGyro()" class="member-name-link">getGyro()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Getter for the <a href="../swervelib/imu/SwerveIMU.html" title="class in swervelib.imu"><code>SwerveIMU</code></a>.</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/CanandgyroSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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/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/SwerveDrive.html#getMaximumAngularVelocity()" class="member-name-link">getMaximumAngularVelocity()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the maximum angular velocity, either <a href="../swervelib/SwerveDrive.html#attainableMaxRotationalVelocityRadiansPerSecond"><code>SwerveDrive.attainableMaxRotationalVelocityRadiansPerSecond</code></a> or
|
|
||||||
<a href="../swervelib/parser/SwerveControllerConfiguration.html#maxAngularVelocity"><code>SwerveControllerConfiguration.maxAngularVelocity</code></a>.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#getMaximumVelocity()" class="member-name-link">getMaximumVelocity()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the maximum velocity from <a href="../swervelib/SwerveDrive.html#attainableMaxTranslationalSpeedMetersPerSecond"><code>SwerveDrive.attainableMaxTranslationalSpeedMetersPerSecond</code></a> or
|
|
||||||
<a href="../swervelib/SwerveDrive.html#maxSpeedMPS"><code>SwerveDrive.maxSpeedMPS</code></a> whichever is higher.</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#getModuleMap()" class="member-name-link">getModuleMap()</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 as a <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link"><code>HashMap</code></a> where the key is the swerve module configuration 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/SparkFlexSwerve.html#getMotor()" class="member-name-link">getMotor()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the motor object from the module.</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/SwerveDrive.html#getOdometryHeading()" class="member-name-link">getOdometryHeading()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Fetch the latest odometry heading, should be trusted over <a href="../swervelib/SwerveDrive.html#getYaw()"><code>SwerveDrive.getYaw()</code></a>.</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/motors/SparkFlexSwerve.html#getPosition()" class="member-name-link">getPosition()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the position of the integrated encoder.</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/imu/ADIS16448Swerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#getRate()" class="member-name-link">getRate()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Fetch the rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/NavXSwerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/SwerveIMU.html#getRate()" class="member-name-link">getRate()</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 rotation rate from the IMU in degrees per second.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveModule.html#getRawAbsolutePosition()" class="member-name-link">getRawAbsolutePosition()</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#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/CanandgyroSwerve.html#getRawRotation3d()" class="member-name-link">getRawRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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/CanandgyroSwerve.html#getRotation3d()" class="member-name-link">getRotation3d()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</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 <code>SwerveModuleState</code> 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/telemetry/Alert.SendableAlerts.html#getStrings(swervelib.telemetry.Alert.AlertType)" class="member-name-link">getStrings(Alert.AlertType)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get alerts based off of type.</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,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 1 joystick [-1,1] and an angle.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveController.html#getTargetSpeeds(double,double,double,double,double,double)" class="member-name-link">getTargetSpeeds(double, 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/parser/Cache.html#getValue()" class="member-name-link">getValue()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the most up to date cached value.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</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 velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CanAndMagSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/CANCoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</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 velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.encoders.<a href="../swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SparkMaxEncoderSwerve.html#getVelocity()" class="member-name-link">getVelocity()</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 velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/SwerveAbsoluteEncoder.html#getVelocity()" class="member-name-link">getVelocity()</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 velocity in degrees/sec.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the robot's angular velocity based on averaged meaasurements from the IMU.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#getVelocity()" class="member-name-link">getVelocity()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the velocity of the integrated encoder.</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/motors/SparkFlexSwerve.html#getVoltage()" class="member-name-link">getVoltage()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the voltage output of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxBrushedMotorSwerve.html#getVoltage()" class="member-name-link">getVoltage()</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 voltage output of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkMaxSwerve.html#getVoltage()" class="member-name-link">getVoltage()</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 voltage output of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SwerveMotor.html#getVoltage()" class="member-name-link">getVoltage()</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 voltage output of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonFXSwerve.html#getVoltage()" class="member-name-link">getVoltage()</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 voltage output of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/TalonSRXSwerve.html#getVoltage()" class="member-name-link">getVoltage()</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 voltage output of the motor controller.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Get the estimated angle of the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.html#groups" class="member-name-link">groups</a> - Static variable in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Group of the alert.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve IMU.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,85 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>H-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: H">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:H">H</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/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/SwerveDrive.html#HEADING_CORRECTION_DEADBAND" class="member-name-link">HEADING_CORRECTION_DEADBAND</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Deadband for speeds in heading correction.</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/SwerveDrive.html#headingCorrection" class="member-name-link">headingCorrection</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Whether to correct heading when driving translationally.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveControllerConfiguration.html#headingPIDF" class="member-name-link">headingPIDF</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">PIDF for the heading of the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#HIGH" class="member-name-link">HIGH</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Full swerve drive data is sent back in both human and machine readable forms.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,256 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>I-Index</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index: I">
|
|
||||||
<meta name="generator" content="javadoc/IndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="index-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="../overview-tree.html">Tree</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Index</li>
|
|
||||||
<li><a href="../help-doc.html#index">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1>Index</h1>
|
|
||||||
</div>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a>
|
|
||||||
<h2 class="title" id="I:I">I</h2>
|
|
||||||
<dl class="index">
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#i" class="member-name-link">i</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Integral Gain for PID.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.html#i2cLockupWarning" class="member-name-link">i2cLockupWarning</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 <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is an I2C lockup issue on the roboRIO.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/DeviceJson.html#id" class="member-name-link">id</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/DeviceJson.html" title="class in swervelib.parser.json">DeviceJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">The CAN ID or pin ID of the device.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><code>ADIS16448_IMU</code> device to read the current headings from.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><code>ADIS16470_IMU</code> device to read the current headings from.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block"><code>ADXRS450_Gyro</code> device to read the current headings from.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Gyroscope object.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Boron Canandgyro by Redux Robotics.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/NavXSwerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">NavX IMU.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Pigeon2 IMU device.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Pigeon v1 IMU device.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/json/SwerveDriveJson.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.parser.json.<a href="../swervelib/parser/json/SwerveDriveJson.html" title="class in swervelib.parser.json">SwerveDriveJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Robot IMU used to determine heading of the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/SwerveDriveConfiguration.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/SwerveDriveConfiguration.html" title="class in swervelib.parser">SwerveDriveConfiguration</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve IMU</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#imu" class="member-name-link">imu</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Swerve IMU device for sensing the heading of the robot.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/IMULinearMovingAverageFilter.html" class="type-name-link" title="class in swervelib.math">IMULinearMovingAverageFilter</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">A linear filter that does not calculate() each time a value is added to
|
|
||||||
the DoubleCircularBuffer.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/math/IMULinearMovingAverageFilter.html#%3Cinit%3E(int)" class="member-name-link">IMULinearMovingAverageFilter(int)</a> - Constructor for class swervelib.math.<a href="../swervelib/math/IMULinearMovingAverageFilter.html" title="class in swervelib.math">IMULinearMovingAverageFilter</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Construct a linear moving average fitler</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#imuReadingCache" class="member-name-link">imuReadingCache</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">IMU reading cache for robot readings.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/SwerveDrive.html#imuVelocity" class="member-name-link">imuVelocity</a> - Variable in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Class that calculates robot's yaw velocity using IMU measurements.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html" class="type-name-link" title="class in swervelib.imu">IMUVelocity</a> - Class in <a href="../swervelib/imu/package-summary.html">swervelib.imu</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Generic IMU Velocity filter.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/IMUVelocity.html#%3Cinit%3E(swervelib.imu.SwerveIMU,double,int)" class="member-name-link">IMUVelocity(SwerveIMU, double, int)</a> - Constructor for class swervelib.imu.<a href="../swervelib/imu/IMUVelocity.html" title="class in swervelib.imu">IMUVelocity</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Constructor for the IMU Velocity.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> detailing how the analog absolute encoder may not report accurate velocities.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">An <a href="../swervelib/telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the encoder cannot report accurate velocities.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.AlertType.html#INFO" class="member-name-link">INFO</a> - Enum constant in enum class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.AlertType.html" title="enum class in swervelib.telemetry">Alert.AlertType</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Low priority alert - displayed last on the dashboard with a green "i" symbol.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html#INFO" class="member-name-link">INFO</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">Medium telemetry data, swerve directory</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/telemetry/Alert.SendableAlerts.html#initSendable(edu.wpi.first.util.sendable.SendableBuilder)" class="member-name-link">initSendable(SendableBuilder)</a> - Method in class swervelib.telemetry.<a href="../swervelib/telemetry/Alert.SendableAlerts.html" title="class in swervelib.telemetry">Alert.SendableAlerts</a></dt>
|
|
||||||
<dd> </dd>
|
|
||||||
<dt><a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html#inverted" class="member-name-link">inverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion state of the encoder.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/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/imu/ADIS16448Swerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/CanandgyroSwerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/CanandgyroSwerve.html" title="class in swervelib.imu">CanandgyroSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/NavXSwerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/Pigeon2Swerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/Pigeon2Swerve.html" title="class in swervelib.imu">Pigeon2Swerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/imu/PigeonSwerve.html#invertedIMU" class="member-name-link">invertedIMU</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/PigeonSwerve.html" title="class in swervelib.imu">PigeonSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion for the gyro</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/json/modules/ConversionFactorsJson.html#isAngleEmpty()" class="member-name-link">isAngleEmpty()</a> - Method in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/ConversionFactorsJson.html" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Check if the conversion factors are set for the angle motor.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/motors/SparkFlexSwerve.html#isAttachedAbsoluteEncoder()" class="member-name-link">isAttachedAbsoluteEncoder()</a> - Method in class swervelib.motors.<a href="../swervelib/motors/SparkFlexSwerve.html" title="class in swervelib.motors">SparkFlexSwerve</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/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/parser/json/modules/ConversionFactorsJson.html#isDriveEmpty()" class="member-name-link">isDriveEmpty()</a> - Method in class swervelib.parser.json.modules.<a href="../swervelib/parser/json/modules/ConversionFactorsJson.html" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Check if the conversion factors are set for the drive motor.</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/encoders/PWMDutyCycleEncoderSwerve.html#isInverted" class="member-name-link">isInverted</a> - Variable in class swervelib.encoders.<a href="../swervelib/encoders/PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Inversion state.</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/Cache.html#isStale()" class="member-name-link">isStale()</a> - Method in class swervelib.parser.<a href="../swervelib/parser/Cache.html" title="class in swervelib.parser">Cache</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Return whether the cache is stale.</div>
|
|
||||||
</dd>
|
|
||||||
<dt><a href="../swervelib/parser/PIDFConfig.html#iz" class="member-name-link">iz</a> - Variable in class swervelib.parser.<a href="../swervelib/parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></dt>
|
|
||||||
<dd>
|
|
||||||
<div class="block">Integral zone of the PID.</div>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
<a href="index-1.html">A</a> <a href="index-2.html">B</a> <a href="index-3.html">C</a> <a href="index-4.html">D</a> <a href="index-5.html">E</a> <a href="index-6.html">F</a> <a href="index-7.html">G</a> <a href="index-8.html">H</a> <a href="index-9.html">I</a> <a href="index-10.html">K</a> <a href="index-11.html">L</a> <a href="index-12.html">M</a> <a href="index-13.html">N</a> <a href="index-14.html">O</a> <a href="index-15.html">P</a> <a href="index-16.html">Q</a> <a href="index-17.html">R</a> <a href="index-18.html">S</a> <a href="index-19.html">T</a> <a href="index-20.html">U</a> <a href="index-21.html">V</a> <a href="index-22.html">W</a> <a href="index-23.html">X</a> <a href="index-24.html">Y</a> <a href="index-25.html">Z</a> <br><a href="../allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="../constant-values.html">Constant Field Values</a></main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
108
docs/index.html
@@ -1,105 +1,3 @@
|
|||||||
<!DOCTYPE HTML>
|
<script>
|
||||||
<html lang="en">
|
window.location.href = "https://broncbotz3481.github.io/YAGSL-Lib/docs/"
|
||||||
<head>
|
</script>
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Overview</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="package index">
|
|
||||||
<meta name="generator" content="javadoc/PackageIndexWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="script.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-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 class="nav-bar-cell1-rev">Overview</li>
|
|
||||||
<li>Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="overview-tree.html">Tree</a></li>
|
|
||||||
<li><a href="index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="help-doc.html#overview">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 id="all-packages-table">
|
|
||||||
<div class="caption"><span>Packages</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Package</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/package-summary.html">swervelib</a></div>
|
|
||||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/encoders/package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/imu/package-summary.html">swervelib.imu</a></div>
|
|
||||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">IMUs used for controlling the robot heading.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/math/package-summary.html">swervelib.math</a></div>
|
|
||||||
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">Mathematics for swerve drives.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/motors/package-summary.html">swervelib.motors</a></div>
|
|
||||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<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>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/parser/package-summary.html">swervelib.parser</a></div>
|
|
||||||
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">JSON Parser for YAGSL configurations.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/parser/deserializer/package-summary.html">swervelib.parser.deserializer</a></div>
|
|
||||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">Deserialize specific variables for outside the parser.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/parser/json/package-summary.html">swervelib.parser.json</a></div>
|
|
||||||
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">JSON Mapped classes for parsing configuration files.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a></div>
|
|
||||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">JSON Mapped Configuration types for modules.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/simulation/package-summary.html">swervelib.simulation</a></div>
|
|
||||||
<div class="col-last odd-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">Classes used to simulate the swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color all-packages-table all-packages-table-tab1"><a href="swervelib/telemetry/package-summary.html">swervelib.telemetry</a></div>
|
|
||||||
<div class="col-last even-row-color all-packages-table all-packages-table-tab1">
|
|
||||||
<div class="block">Telemetry package for sending data to NT4 or SmartDashboard.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|||||||
34
docs/jquery-ui.overrides.css
vendored
@@ -1,34 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2020, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
||||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
||||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
.ui-state-active,
|
|
||||||
.ui-widget-content .ui-state-active,
|
|
||||||
.ui-widget-header .ui-state-active,
|
|
||||||
a.ui-button:active,
|
|
||||||
.ui-button:active,
|
|
||||||
.ui-button.ui-state-active:hover {
|
|
||||||
/* Overrides the color of selection used in jQuery UI */
|
|
||||||
background: #F8981D;
|
|
||||||
}
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
Please see ..\java.base\ADDITIONAL_LICENSE_INFO
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
Please see ..\java.base\ASSEMBLY_EXCEPTION
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
Please see ..\java.base\LICENSE
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
## jQuery v3.5.1
|
|
||||||
|
|
||||||
### jQuery License
|
|
||||||
```
|
|
||||||
jQuery v 3.5.1
|
|
||||||
Copyright JS Foundation and other contributors, https://js.foundation/
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
"Software"), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
||||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
||||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
||||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
||||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
******************************************
|
|
||||||
|
|
||||||
The jQuery JavaScript Library v3.5.1 also includes Sizzle.js
|
|
||||||
|
|
||||||
Sizzle.js includes the following license:
|
|
||||||
|
|
||||||
Copyright JS Foundation and other contributors, https://js.foundation/
|
|
||||||
|
|
||||||
This software consists of voluntary contributions made by many
|
|
||||||
individuals. For exact contribution history, see the revision history
|
|
||||||
available at https://github.com/jquery/sizzle
|
|
||||||
|
|
||||||
The following license applies to all parts of this software except as
|
|
||||||
documented below:
|
|
||||||
|
|
||||||
====
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
"Software"), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
||||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
||||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
||||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
||||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
====
|
|
||||||
|
|
||||||
All files located in the node_modules and external directories are
|
|
||||||
externally maintained libraries used by this software which have their
|
|
||||||
own licenses; we recommend you read them, as their terms may differ from
|
|
||||||
the terms above.
|
|
||||||
|
|
||||||
*********************
|
|
||||||
|
|
||||||
```
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
## jQuery UI v1.12.1
|
|
||||||
|
|
||||||
### jQuery UI License
|
|
||||||
```
|
|
||||||
Copyright jQuery Foundation and other contributors, https://jquery.org/
|
|
||||||
|
|
||||||
This software consists of voluntary contributions made by many
|
|
||||||
individuals. For exact contribution history, see the revision history
|
|
||||||
available at https://github.com/jquery/jquery-ui
|
|
||||||
|
|
||||||
The following license applies to all parts of this software except as
|
|
||||||
documented below:
|
|
||||||
|
|
||||||
====
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
"Software"), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
||||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
||||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
||||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
||||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
====
|
|
||||||
|
|
||||||
Copyright and related rights for sample code are waived via CC0. Sample
|
|
||||||
code is defined as all source code contained within the demos directory.
|
|
||||||
|
|
||||||
CC0: http://creativecommons.org/publicdomain/zero/1.0/
|
|
||||||
|
|
||||||
====
|
|
||||||
|
|
||||||
All files located in the node_modules and external directories are
|
|
||||||
externally maintained libraries used by this software which have their
|
|
||||||
own licenses; we recommend you read them, as their terms may differ from
|
|
||||||
the terms above.
|
|
||||||
|
|
||||||
```
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
moduleSearchIndex = [];updateSearchResults();
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Generated Documentation (Untitled)</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="index redirect">
|
|
||||||
<meta name="generator" content="javadoc/IndexRedirectWriter">
|
|
||||||
<link rel="canonical" href="index.html">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<script type="text/javascript">window.location.replace('index.html')</script>
|
|
||||||
<noscript>
|
|
||||||
<meta http-equiv="Refresh" content="0;index.html">
|
|
||||||
</noscript>
|
|
||||||
</head>
|
|
||||||
<body class="index-redirect-page">
|
|
||||||
<main role="main">
|
|
||||||
<noscript>
|
|
||||||
<p>JavaScript is disabled on your browser.</p>
|
|
||||||
</noscript>
|
|
||||||
<p><a href="index.html">index.html</a></p>
|
|
||||||
</main>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,162 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>Class Hierarchy</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="class tree">
|
|
||||||
<meta name="generator" content="javadoc/TreeWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="script.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="tree-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 class="nav-bar-cell1-rev">Tree</li>
|
|
||||||
<li><a href="index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="help-doc.html#tree">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 class="title">Hierarchy For All Packages</h1>
|
|
||||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
|
||||||
<ul class="horizontal">
|
|
||||||
<li><a href="swervelib/package-tree.html">swervelib</a>, </li>
|
|
||||||
<li><a href="swervelib/encoders/package-tree.html">swervelib.encoders</a>, </li>
|
|
||||||
<li><a href="swervelib/imu/package-tree.html">swervelib.imu</a>, </li>
|
|
||||||
<li><a href="swervelib/math/package-tree.html">swervelib.math</a>, </li>
|
|
||||||
<li><a href="swervelib/motors/package-tree.html">swervelib.motors</a>, </li>
|
|
||||||
<li><a href="swervelib/parser/package-tree.html">swervelib.parser</a>, </li>
|
|
||||||
<li><a href="swervelib/parser/deserializer/package-tree.html">swervelib.parser.deserializer</a>, </li>
|
|
||||||
<li><a href="swervelib/parser/json/package-tree.html">swervelib.parser.json</a>, </li>
|
|
||||||
<li><a href="swervelib/parser/json/modules/package-tree.html">swervelib.parser.json.modules</a>, </li>
|
|
||||||
<li><a href="swervelib/simulation/package-tree.html">swervelib.simulation</a>, </li>
|
|
||||||
<li><a href="swervelib/telemetry/package-tree.html">swervelib.telemetry</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/Alert.html" class="type-name-link" title="class in swervelib.telemetry">Alert</a></li>
|
|
||||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/Alert.SendableAlerts.html" class="type-name-link" title="class in swervelib.telemetry">Alert.SendableAlerts</a> (implements edu.wpi.first.util.sendable.Sendable)</li>
|
|
||||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/AngleConversionFactorsJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">AngleConversionFactorsJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/BoolMotorJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">BoolMotorJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/Cache.html" class="type-name-link" title="class in swervelib.parser">Cache</a><T></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ControllerPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">ControllerPropertiesJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/ConversionFactorsJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">ConversionFactorsJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/DeviceJson.html" class="type-name-link" title="class in swervelib.parser.json">DeviceJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/DriveConversionFactorsJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">DriveConversionFactorsJson</a></li>
|
|
||||||
<li class="circle">swervelib.math.<a href="swervelib/math/IMULinearMovingAverageFilter.html" class="type-name-link" title="class in swervelib.math">IMULinearMovingAverageFilter</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/IMUVelocity.html" class="type-name-link" title="class in swervelib.imu">IMUVelocity</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.modules.<a href="swervelib/parser/json/modules/LocationJson.html" class="type-name-link" title="class in swervelib.parser.json.modules">LocationJson</a></li>
|
|
||||||
<li class="circle">swervelib.math.<a href="swervelib/math/Matter.html" class="type-name-link" title="class in swervelib.math">Matter</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/ModuleJson.html" class="type-name-link" title="class in swervelib.parser.json">ModuleJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigDouble.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigDouble</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/MotorConfigInt.html" class="type-name-link" title="class in swervelib.parser.json">MotorConfigInt</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PhysicalPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PhysicalPropertiesJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/PIDFConfig.html" class="type-name-link" title="class in swervelib.parser">PIDFConfig</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/PIDFPropertiesJson.html" class="type-name-link" title="class in swervelib.parser.json">PIDFPropertiesJson</a></li>
|
|
||||||
<li class="circle">swervelib.parser.deserializer.<a href="swervelib/parser/deserializer/PIDFRange.html" class="type-name-link" title="class in swervelib.parser.deserializer">PIDFRange</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/AnalogAbsoluteEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/CanAndMagSwerve.html" class="type-name-link" title="class in swervelib.encoders">CanAndMagSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/CANCoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">CANCoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/PWMDutyCycleEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/SparkMaxAnalogEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="swervelib/encoders/SparkMaxEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="circle">swervelib.<a href="swervelib/SwerveController.html" class="type-name-link" title="class in swervelib">SwerveController</a></li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveControllerConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveControllerConfiguration</a></li>
|
|
||||||
<li class="circle">swervelib.<a href="swervelib/SwerveDrive.html" class="type-name-link" title="class in swervelib">SwerveDrive</a></li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveDriveConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveDriveConfiguration</a></li>
|
|
||||||
<li class="circle">swervelib.parser.json.<a href="swervelib/parser/json/SwerveDriveJson.html" class="type-name-link" title="class in swervelib.parser.json">SwerveDriveJson</a></li>
|
|
||||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/SwerveDriveTelemetry.html" class="type-name-link" title="class in swervelib.telemetry">SwerveDriveTelemetry</a></li>
|
|
||||||
<li class="circle">swervelib.<a href="swervelib/SwerveDriveTest.html" class="type-name-link" title="class in swervelib">SwerveDriveTest</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/SwerveIMU.html" class="type-name-link" title="class in swervelib.imu">SwerveIMU</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/ADIS16448Swerve.html" class="type-name-link" title="class in swervelib.imu">ADIS16448Swerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/ADIS16470Swerve.html" class="type-name-link" title="class in swervelib.imu">ADIS16470Swerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/ADXRS450Swerve.html" class="type-name-link" title="class in swervelib.imu">ADXRS450Swerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/AnalogGyroSwerve.html" class="type-name-link" title="class in swervelib.imu">AnalogGyroSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/CanandgyroSwerve.html" class="type-name-link" title="class in swervelib.imu">CanandgyroSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/NavXSwerve.html" class="type-name-link" title="class in swervelib.imu">NavXSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/Pigeon2Swerve.html" class="type-name-link" title="class in swervelib.imu">Pigeon2Swerve</a></li>
|
|
||||||
<li class="circle">swervelib.imu.<a href="swervelib/imu/PigeonSwerve.html" class="type-name-link" title="class in swervelib.imu">PigeonSwerve</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="circle">swervelib.simulation.<a href="swervelib/simulation/SwerveIMUSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveIMUSimulation</a></li>
|
|
||||||
<li class="circle">swervelib.math.<a href="swervelib/math/SwerveMath.html" class="type-name-link" title="class in swervelib.math">SwerveMath</a></li>
|
|
||||||
<li class="circle">swervelib.<a href="swervelib/SwerveModule.html" class="type-name-link" title="class in swervelib">SwerveModule</a></li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveModuleConfiguration.html" class="type-name-link" title="class in swervelib.parser">SwerveModuleConfiguration</a></li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveModulePhysicalCharacteristics.html" class="type-name-link" title="class in swervelib.parser">SwerveModulePhysicalCharacteristics</a></li>
|
|
||||||
<li class="circle">swervelib.simulation.<a href="swervelib/simulation/SwerveModuleSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveModuleSimulation</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SwerveMotor.html" class="type-name-link" title="class in swervelib.motors">SwerveMotor</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkFlexSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkFlexSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxBrushedMotorSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxBrushedMotorSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxSwerve.html" class="type-name-link" title="class in swervelib.motors">SparkMaxSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/TalonFXSwerve.html" class="type-name-link" title="class in swervelib.motors">TalonFXSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/TalonSRXSwerve.html" class="type-name-link" title="class in swervelib.motors">TalonSRXSwerve</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
<li class="circle">swervelib.parser.<a href="swervelib/parser/SwerveParser.html" class="type-name-link" title="class in swervelib.parser">SwerveParser</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Enum Class Hierarchy">Enum Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Enum.html" class="type-name-link external-link" title="class or interface in java.lang">Enum</a><E> (implements java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><T>, java.lang.constant.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a>, java.io.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>)
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/Alert.AlertType.html" class="type-name-link" title="enum class in swervelib.telemetry">Alert.AlertType</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkFlexSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkFlexSwerve.SparkMAX_slotIdx</a></li>
|
|
||||||
<li class="circle">swervelib.motors.<a href="swervelib/motors/SparkMaxSwerve.SparkMAX_slotIdx.html" class="type-name-link" title="enum class in swervelib.motors">SparkMaxSwerve.SparkMAX_slotIdx</a></li>
|
|
||||||
<li class="circle">swervelib.telemetry.<a href="swervelib/telemetry/SwerveDriveTelemetry.TelemetryVerbosity.html" class="type-name-link" title="enum class in swervelib.telemetry">SwerveDriveTelemetry.TelemetryVerbosity</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"swervelib"},{"l":"swervelib.encoders"},{"l":"swervelib.imu"},{"l":"swervelib.math"},{"l":"swervelib.motors"},{"l":"swervelib.parser"},{"l":"swervelib.parser.deserializer"},{"l":"swervelib.parser.json"},{"l":"swervelib.parser.json.modules"},{"l":"swervelib.simulation"},{"l":"swervelib.telemetry"}];updateSearchResults();
|
|
||||||
|
Before Width: | Height: | Size: 499 B |
|
Before Width: | Height: | Size: 394 B |
|
Before Width: | Height: | Size: 335 B |
|
Before Width: | Height: | Size: 262 B |
|
Before Width: | Height: | Size: 262 B |
|
Before Width: | Height: | Size: 262 B |
|
Before Width: | Height: | Size: 332 B |
|
Before Width: | Height: | Size: 280 B |
|
Before Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 4.4 KiB |
2
docs/script-dir/jquery-3.5.1.min.js
vendored
2
docs/script-dir/jquery-3.6.0.min.js
vendored
7
docs/script-dir/jquery-ui.min.css
vendored
6
docs/script-dir/jquery-ui.min.js
vendored
5
docs/script-dir/jquery-ui.structure.min.css
vendored
@@ -1,5 +0,0 @@
|
|||||||
/*! jQuery UI - v1.12.1 - 2018-12-06
|
|
||||||
* http://jqueryui.com
|
|
||||||
* Copyright jQuery Foundation and other contributors; Licensed MIT */
|
|
||||||
|
|
||||||
.ui-helper-hidden{display:none}.ui-helper-hidden-accessible{border:0;clip:rect(0 0 0 0);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}.ui-helper-reset{margin:0;padding:0;border:0;outline:0;line-height:1.3;text-decoration:none;font-size:100%;list-style:none}.ui-helper-clearfix:before,.ui-helper-clearfix:after{content:"";display:table;border-collapse:collapse}.ui-helper-clearfix:after{clear:both}.ui-helper-zfix{width:100%;height:100%;top:0;left:0;position:absolute;opacity:0;filter:Alpha(Opacity=0)}.ui-front{z-index:100}.ui-state-disabled{cursor:default!important;pointer-events:none}.ui-icon{display:inline-block;vertical-align:middle;margin-top:-.25em;position:relative;text-indent:-99999px;overflow:hidden;background-repeat:no-repeat}.ui-widget-icon-block{left:50%;margin-left:-8px;display:block}.ui-widget-overlay{position:fixed;top:0;left:0;width:100%;height:100%}.ui-autocomplete{position:absolute;top:0;left:0;cursor:default}.ui-menu{list-style:none;padding:0;margin:0;display:block;outline:0}.ui-menu .ui-menu{position:absolute}.ui-menu .ui-menu-item{margin:0;cursor:pointer;list-style-image:url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7")}.ui-menu .ui-menu-item-wrapper{position:relative;padding:3px 1em 3px .4em}.ui-menu .ui-menu-divider{margin:5px 0;height:0;font-size:0;line-height:0;border-width:1px 0 0 0}.ui-menu .ui-state-focus,.ui-menu .ui-state-active{margin:-1px}.ui-menu-icons{position:relative}.ui-menu-icons .ui-menu-item-wrapper{padding-left:2em}.ui-menu .ui-icon{position:absolute;top:0;bottom:0;left:.2em;margin:auto 0}.ui-menu .ui-menu-icon{left:auto;right:0}
|
|
||||||
132
docs/script.js
@@ -1,132 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
||||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
||||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
var moduleSearchIndex;
|
|
||||||
var packageSearchIndex;
|
|
||||||
var typeSearchIndex;
|
|
||||||
var memberSearchIndex;
|
|
||||||
var tagSearchIndex;
|
|
||||||
function loadScripts(doc, tag) {
|
|
||||||
createElem(doc, tag, 'search.js');
|
|
||||||
|
|
||||||
createElem(doc, tag, 'module-search-index.js');
|
|
||||||
createElem(doc, tag, 'package-search-index.js');
|
|
||||||
createElem(doc, tag, 'type-search-index.js');
|
|
||||||
createElem(doc, tag, 'member-search-index.js');
|
|
||||||
createElem(doc, tag, 'tag-search-index.js');
|
|
||||||
}
|
|
||||||
|
|
||||||
function createElem(doc, tag, path) {
|
|
||||||
var script = doc.createElement(tag);
|
|
||||||
var scriptElement = doc.getElementsByTagName(tag)[0];
|
|
||||||
script.src = pathtoroot + path;
|
|
||||||
scriptElement.parentNode.insertBefore(script, scriptElement);
|
|
||||||
}
|
|
||||||
|
|
||||||
function show(tableId, selected, columns) {
|
|
||||||
if (tableId !== selected) {
|
|
||||||
document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
|
|
||||||
.forEach(function(elem) {
|
|
||||||
elem.style.display = 'none';
|
|
||||||
});
|
|
||||||
}
|
|
||||||
document.querySelectorAll('div.' + selected)
|
|
||||||
.forEach(function(elem, index) {
|
|
||||||
elem.style.display = '';
|
|
||||||
var isEvenRow = index % (columns * 2) < columns;
|
|
||||||
elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor);
|
|
||||||
elem.classList.add(isEvenRow ? evenRowColor : oddRowColor);
|
|
||||||
});
|
|
||||||
updateTabs(tableId, selected);
|
|
||||||
}
|
|
||||||
|
|
||||||
function updateTabs(tableId, selected) {
|
|
||||||
document.querySelector('div#' + tableId +' .summary-table')
|
|
||||||
.setAttribute('aria-labelledby', selected);
|
|
||||||
document.querySelectorAll('button[id^="' + tableId + '"]')
|
|
||||||
.forEach(function(tab, index) {
|
|
||||||
if (selected === tab.id || (tableId === selected && index === 0)) {
|
|
||||||
tab.className = activeTableTab;
|
|
||||||
tab.setAttribute('aria-selected', true);
|
|
||||||
tab.setAttribute('tabindex',0);
|
|
||||||
} else {
|
|
||||||
tab.className = tableTab;
|
|
||||||
tab.setAttribute('aria-selected', false);
|
|
||||||
tab.setAttribute('tabindex',-1);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
function switchTab(e) {
|
|
||||||
var selected = document.querySelector('[aria-selected=true]');
|
|
||||||
if (selected) {
|
|
||||||
if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
|
|
||||||
// left or up arrow key pressed: move focus to previous tab
|
|
||||||
selected.previousSibling.click();
|
|
||||||
selected.previousSibling.focus();
|
|
||||||
e.preventDefault();
|
|
||||||
} else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
|
|
||||||
// right or down arrow key pressed: move focus to next tab
|
|
||||||
selected.nextSibling.click();
|
|
||||||
selected.nextSibling.focus();
|
|
||||||
e.preventDefault();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var updateSearchResults = function() {};
|
|
||||||
|
|
||||||
function indexFilesLoaded() {
|
|
||||||
return moduleSearchIndex
|
|
||||||
&& packageSearchIndex
|
|
||||||
&& typeSearchIndex
|
|
||||||
&& memberSearchIndex
|
|
||||||
&& tagSearchIndex;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Workaround for scroll position not being included in browser history (8249133)
|
|
||||||
document.addEventListener("DOMContentLoaded", function(e) {
|
|
||||||
var contentDiv = document.querySelector("div.flex-content");
|
|
||||||
window.addEventListener("popstate", function(e) {
|
|
||||||
if (e.state !== null) {
|
|
||||||
contentDiv.scrollTop = e.state;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
window.addEventListener("hashchange", function(e) {
|
|
||||||
history.replaceState(contentDiv.scrollTop, document.title);
|
|
||||||
});
|
|
||||||
contentDiv.addEventListener("scroll", function(e) {
|
|
||||||
var timeoutID;
|
|
||||||
if (!timeoutID) {
|
|
||||||
timeoutID = setTimeout(function() {
|
|
||||||
history.replaceState(contentDiv.scrollTop, document.title);
|
|
||||||
timeoutID = null;
|
|
||||||
}, 100);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
if (!location.hash) {
|
|
||||||
history.replaceState(contentDiv.scrollTop, document.title);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
354
docs/search.js
@@ -1,354 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2015, 2020, Oracle and/or its affiliates. All rights reserved.
|
|
||||||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
||||||
*
|
|
||||||
* This code is free software; you can redistribute it and/or modify it
|
|
||||||
* under the terms of the GNU General Public License version 2 only, as
|
|
||||||
* published by the Free Software Foundation. Oracle designates this
|
|
||||||
* particular file as subject to the "Classpath" exception as provided
|
|
||||||
* by Oracle in the LICENSE file that accompanied this code.
|
|
||||||
*
|
|
||||||
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
||||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
||||||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
||||||
* version 2 for more details (a copy is included in the LICENSE file that
|
|
||||||
* accompanied this code).
|
|
||||||
*
|
|
||||||
* You should have received a copy of the GNU General Public License version
|
|
||||||
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
||||||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
||||||
*
|
|
||||||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
||||||
* or visit www.oracle.com if you need additional information or have any
|
|
||||||
* questions.
|
|
||||||
*/
|
|
||||||
|
|
||||||
var noResult = {l: "No results found"};
|
|
||||||
var loading = {l: "Loading search index..."};
|
|
||||||
var catModules = "Modules";
|
|
||||||
var catPackages = "Packages";
|
|
||||||
var catTypes = "Classes and Interfaces";
|
|
||||||
var catMembers = "Members";
|
|
||||||
var catSearchTags = "Search Tags";
|
|
||||||
var highlight = "<span class=\"result-highlight\">$&</span>";
|
|
||||||
var searchPattern = "";
|
|
||||||
var fallbackPattern = "";
|
|
||||||
var RANKING_THRESHOLD = 2;
|
|
||||||
var NO_MATCH = 0xffff;
|
|
||||||
var MIN_RESULTS = 3;
|
|
||||||
var MAX_RESULTS = 500;
|
|
||||||
var UNNAMED = "<Unnamed>";
|
|
||||||
function escapeHtml(str) {
|
|
||||||
return str.replace(/</g, "<").replace(/>/g, ">");
|
|
||||||
}
|
|
||||||
function getHighlightedText(item, matcher, fallbackMatcher) {
|
|
||||||
var escapedItem = escapeHtml(item);
|
|
||||||
var highlighted = escapedItem.replace(matcher, highlight);
|
|
||||||
if (highlighted === escapedItem) {
|
|
||||||
highlighted = escapedItem.replace(fallbackMatcher, highlight)
|
|
||||||
}
|
|
||||||
return highlighted;
|
|
||||||
}
|
|
||||||
function getURLPrefix(ui) {
|
|
||||||
var urlPrefix="";
|
|
||||||
var slash = "/";
|
|
||||||
if (ui.item.category === catModules) {
|
|
||||||
return ui.item.l + slash;
|
|
||||||
} else if (ui.item.category === catPackages && ui.item.m) {
|
|
||||||
return ui.item.m + slash;
|
|
||||||
} else if (ui.item.category === catTypes || ui.item.category === catMembers) {
|
|
||||||
if (ui.item.m) {
|
|
||||||
urlPrefix = ui.item.m + slash;
|
|
||||||
} else {
|
|
||||||
$.each(packageSearchIndex, function(index, item) {
|
|
||||||
if (item.m && ui.item.p === item.l) {
|
|
||||||
urlPrefix = item.m + slash;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return urlPrefix;
|
|
||||||
}
|
|
||||||
function createSearchPattern(term) {
|
|
||||||
var pattern = "";
|
|
||||||
var isWordToken = false;
|
|
||||||
term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) {
|
|
||||||
if (index > 0) {
|
|
||||||
// whitespace between identifiers is significant
|
|
||||||
pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*";
|
|
||||||
}
|
|
||||||
var tokens = w.split(/(?=[A-Z,.()<>[\/])/);
|
|
||||||
for (var i = 0; i < tokens.length; i++) {
|
|
||||||
var s = tokens[i];
|
|
||||||
if (s === "") {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
pattern += $.ui.autocomplete.escapeRegex(s);
|
|
||||||
isWordToken = /\w$/.test(s);
|
|
||||||
if (isWordToken) {
|
|
||||||
pattern += "([a-z0-9_$<>\\[\\]]*?)";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
return pattern;
|
|
||||||
}
|
|
||||||
function createMatcher(pattern, flags) {
|
|
||||||
var isCamelCase = /[A-Z]/.test(pattern);
|
|
||||||
return new RegExp(pattern, flags + (isCamelCase ? "" : "i"));
|
|
||||||
}
|
|
||||||
var watermark = 'Search';
|
|
||||||
$(function() {
|
|
||||||
var search = $("#search-input");
|
|
||||||
var reset = $("#reset-button");
|
|
||||||
search.val('');
|
|
||||||
search.prop("disabled", false);
|
|
||||||
reset.prop("disabled", false);
|
|
||||||
search.val(watermark).addClass('watermark');
|
|
||||||
search.blur(function() {
|
|
||||||
if ($(this).val().length === 0) {
|
|
||||||
$(this).val(watermark).addClass('watermark');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
search.on('click keydown paste', function() {
|
|
||||||
if ($(this).val() === watermark) {
|
|
||||||
$(this).val('').removeClass('watermark');
|
|
||||||
}
|
|
||||||
});
|
|
||||||
reset.click(function() {
|
|
||||||
search.val('').focus();
|
|
||||||
});
|
|
||||||
search.focus()[0].setSelectionRange(0, 0);
|
|
||||||
});
|
|
||||||
$.widget("custom.catcomplete", $.ui.autocomplete, {
|
|
||||||
_create: function() {
|
|
||||||
this._super();
|
|
||||||
this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)");
|
|
||||||
},
|
|
||||||
_renderMenu: function(ul, items) {
|
|
||||||
var rMenu = this;
|
|
||||||
var currentCategory = "";
|
|
||||||
rMenu.menu.bindings = $();
|
|
||||||
$.each(items, function(index, item) {
|
|
||||||
var li;
|
|
||||||
if (item.category && item.category !== currentCategory) {
|
|
||||||
ul.append("<li class=\"ui-autocomplete-category\">" + item.category + "</li>");
|
|
||||||
currentCategory = item.category;
|
|
||||||
}
|
|
||||||
li = rMenu._renderItemData(ul, item);
|
|
||||||
if (item.category) {
|
|
||||||
li.attr("aria-label", item.category + " : " + item.l);
|
|
||||||
li.attr("class", "result-item");
|
|
||||||
} else {
|
|
||||||
li.attr("aria-label", item.l);
|
|
||||||
li.attr("class", "result-item");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
},
|
|
||||||
_renderItem: function(ul, item) {
|
|
||||||
var label = "";
|
|
||||||
var matcher = createMatcher(escapeHtml(searchPattern), "g");
|
|
||||||
var fallbackMatcher = new RegExp(fallbackPattern, "gi")
|
|
||||||
if (item.category === catModules) {
|
|
||||||
label = getHighlightedText(item.l, matcher, fallbackMatcher);
|
|
||||||
} else if (item.category === catPackages) {
|
|
||||||
label = getHighlightedText(item.l, matcher, fallbackMatcher);
|
|
||||||
} else if (item.category === catTypes) {
|
|
||||||
label = (item.p && item.p !== UNNAMED)
|
|
||||||
? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher)
|
|
||||||
: getHighlightedText(item.l, matcher, fallbackMatcher);
|
|
||||||
} else if (item.category === catMembers) {
|
|
||||||
label = (item.p && item.p !== UNNAMED)
|
|
||||||
? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher)
|
|
||||||
: getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher);
|
|
||||||
} else if (item.category === catSearchTags) {
|
|
||||||
label = getHighlightedText(item.l, matcher, fallbackMatcher);
|
|
||||||
} else {
|
|
||||||
label = item.l;
|
|
||||||
}
|
|
||||||
var li = $("<li/>").appendTo(ul);
|
|
||||||
var div = $("<div/>").appendTo(li);
|
|
||||||
if (item.category === catSearchTags && item.h) {
|
|
||||||
if (item.d) {
|
|
||||||
div.html(label + "<span class=\"search-tag-holder-result\"> (" + item.h + ")</span><br><span class=\"search-tag-desc-result\">"
|
|
||||||
+ item.d + "</span><br>");
|
|
||||||
} else {
|
|
||||||
div.html(label + "<span class=\"search-tag-holder-result\"> (" + item.h + ")</span>");
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if (item.m) {
|
|
||||||
div.html(item.m + "/" + label);
|
|
||||||
} else {
|
|
||||||
div.html(label);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return li;
|
|
||||||
}
|
|
||||||
});
|
|
||||||
function rankMatch(match, category) {
|
|
||||||
if (!match) {
|
|
||||||
return NO_MATCH;
|
|
||||||
}
|
|
||||||
var index = match.index;
|
|
||||||
var input = match.input;
|
|
||||||
var leftBoundaryMatch = 2;
|
|
||||||
var periferalMatch = 0;
|
|
||||||
// make sure match is anchored on a left word boundary
|
|
||||||
if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) {
|
|
||||||
leftBoundaryMatch = 0;
|
|
||||||
} else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) {
|
|
||||||
leftBoundaryMatch = 1;
|
|
||||||
}
|
|
||||||
var matchEnd = index + match[0].length;
|
|
||||||
var leftParen = input.indexOf("(");
|
|
||||||
var endOfName = leftParen > -1 ? leftParen : input.length;
|
|
||||||
// exclude peripheral matches
|
|
||||||
if (category !== catModules && category !== catSearchTags) {
|
|
||||||
var delim = category === catPackages ? "/" : ".";
|
|
||||||
if (leftParen > -1 && leftParen < index) {
|
|
||||||
periferalMatch += 2;
|
|
||||||
} else if (input.lastIndexOf(delim, endOfName) >= matchEnd) {
|
|
||||||
periferalMatch += 2;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match
|
|
||||||
for (var i = 1; i < match.length; i++) {
|
|
||||||
// lower ranking if parts of the name are missing
|
|
||||||
if (match[i])
|
|
||||||
delta += match[i].length;
|
|
||||||
}
|
|
||||||
if (category === catTypes) {
|
|
||||||
// lower ranking if a type name contains unmatched camel-case parts
|
|
||||||
if (/[A-Z]/.test(input.substring(matchEnd)))
|
|
||||||
delta += 5;
|
|
||||||
if (/[A-Z]/.test(input.substring(0, index)))
|
|
||||||
delta += 5;
|
|
||||||
}
|
|
||||||
return leftBoundaryMatch + periferalMatch + (delta / 200);
|
|
||||||
|
|
||||||
}
|
|
||||||
function doSearch(request, response) {
|
|
||||||
var result = [];
|
|
||||||
searchPattern = createSearchPattern(request.term);
|
|
||||||
fallbackPattern = createSearchPattern(request.term.toLowerCase());
|
|
||||||
if (searchPattern === "") {
|
|
||||||
return this.close();
|
|
||||||
}
|
|
||||||
var camelCaseMatcher = createMatcher(searchPattern, "");
|
|
||||||
var fallbackMatcher = new RegExp(fallbackPattern, "i");
|
|
||||||
|
|
||||||
function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) {
|
|
||||||
if (indexArray) {
|
|
||||||
var newResults = [];
|
|
||||||
$.each(indexArray, function (i, item) {
|
|
||||||
item.category = category;
|
|
||||||
var ranking = rankMatch(matcher.exec(nameFunc(item)), category);
|
|
||||||
if (ranking < RANKING_THRESHOLD) {
|
|
||||||
newResults.push({ranking: ranking, item: item});
|
|
||||||
}
|
|
||||||
return newResults.length <= MAX_RESULTS;
|
|
||||||
});
|
|
||||||
return newResults.sort(function(e1, e2) {
|
|
||||||
return e1.ranking - e2.ranking;
|
|
||||||
}).map(function(e) {
|
|
||||||
return e.item;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return [];
|
|
||||||
}
|
|
||||||
function searchIndex(indexArray, category, nameFunc) {
|
|
||||||
var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc);
|
|
||||||
result = result.concat(primaryResults);
|
|
||||||
if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) {
|
|
||||||
var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc);
|
|
||||||
result = result.concat(secondaryResults.filter(function (item) {
|
|
||||||
return primaryResults.indexOf(item) === -1;
|
|
||||||
}));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; });
|
|
||||||
searchIndex(packageSearchIndex, catPackages, function(item) {
|
|
||||||
return (item.m && request.term.indexOf("/") > -1)
|
|
||||||
? (item.m + "/" + item.l) : item.l;
|
|
||||||
});
|
|
||||||
searchIndex(typeSearchIndex, catTypes, function(item) {
|
|
||||||
return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l;
|
|
||||||
});
|
|
||||||
searchIndex(memberSearchIndex, catMembers, function(item) {
|
|
||||||
return request.term.indexOf(".") > -1
|
|
||||||
? item.p + "." + item.c + "." + item.l : item.l;
|
|
||||||
});
|
|
||||||
searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; });
|
|
||||||
|
|
||||||
if (!indexFilesLoaded()) {
|
|
||||||
updateSearchResults = function() {
|
|
||||||
doSearch(request, response);
|
|
||||||
}
|
|
||||||
result.unshift(loading);
|
|
||||||
} else {
|
|
||||||
updateSearchResults = function() {};
|
|
||||||
}
|
|
||||||
response(result);
|
|
||||||
}
|
|
||||||
$(function() {
|
|
||||||
$("#search-input").catcomplete({
|
|
||||||
minLength: 1,
|
|
||||||
delay: 300,
|
|
||||||
source: doSearch,
|
|
||||||
response: function(event, ui) {
|
|
||||||
if (!ui.content.length) {
|
|
||||||
ui.content.push(noResult);
|
|
||||||
} else {
|
|
||||||
$("#search-input").empty();
|
|
||||||
}
|
|
||||||
},
|
|
||||||
autoFocus: true,
|
|
||||||
focus: function(event, ui) {
|
|
||||||
return false;
|
|
||||||
},
|
|
||||||
position: {
|
|
||||||
collision: "flip"
|
|
||||||
},
|
|
||||||
select: function(event, ui) {
|
|
||||||
if (ui.item.category) {
|
|
||||||
var url = getURLPrefix(ui);
|
|
||||||
if (ui.item.category === catModules) {
|
|
||||||
url += "module-summary.html";
|
|
||||||
} else if (ui.item.category === catPackages) {
|
|
||||||
if (ui.item.u) {
|
|
||||||
url = ui.item.u;
|
|
||||||
} else {
|
|
||||||
url += ui.item.l.replace(/\./g, '/') + "/package-summary.html";
|
|
||||||
}
|
|
||||||
} else if (ui.item.category === catTypes) {
|
|
||||||
if (ui.item.u) {
|
|
||||||
url = ui.item.u;
|
|
||||||
} else if (ui.item.p === UNNAMED) {
|
|
||||||
url += ui.item.l + ".html";
|
|
||||||
} else {
|
|
||||||
url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html";
|
|
||||||
}
|
|
||||||
} else if (ui.item.category === catMembers) {
|
|
||||||
if (ui.item.p === UNNAMED) {
|
|
||||||
url += ui.item.c + ".html" + "#";
|
|
||||||
} else {
|
|
||||||
url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#";
|
|
||||||
}
|
|
||||||
if (ui.item.u) {
|
|
||||||
url += ui.item.u;
|
|
||||||
} else {
|
|
||||||
url += ui.item.l;
|
|
||||||
}
|
|
||||||
} else if (ui.item.category === catSearchTags) {
|
|
||||||
url += ui.item.u;
|
|
||||||
}
|
|
||||||
if (top !== window) {
|
|
||||||
parent.classFrame.location = pathtoroot + url;
|
|
||||||
} else {
|
|
||||||
window.location.href = pathtoroot + url;
|
|
||||||
}
|
|
||||||
$("#search-input").focus();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
@@ -1,865 +0,0 @@
|
|||||||
/*
|
|
||||||
* Javadoc style sheet
|
|
||||||
*/
|
|
||||||
|
|
||||||
@import url('resources/fonts/dejavu.css');
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Styles for individual HTML elements.
|
|
||||||
*
|
|
||||||
* These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
|
|
||||||
* HTML element throughout the page.
|
|
||||||
*/
|
|
||||||
|
|
||||||
body {
|
|
||||||
background-color:#ffffff;
|
|
||||||
color:#353833;
|
|
||||||
font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
|
|
||||||
font-size:14px;
|
|
||||||
margin:0;
|
|
||||||
padding:0;
|
|
||||||
height:100%;
|
|
||||||
width:100%;
|
|
||||||
}
|
|
||||||
iframe {
|
|
||||||
margin:0;
|
|
||||||
padding:0;
|
|
||||||
height:100%;
|
|
||||||
width:100%;
|
|
||||||
overflow-y:scroll;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
a:link, a:visited {
|
|
||||||
text-decoration:none;
|
|
||||||
color:#4A6782;
|
|
||||||
}
|
|
||||||
a[href]:hover, a[href]:focus {
|
|
||||||
text-decoration:none;
|
|
||||||
color:#bb7a2a;
|
|
||||||
}
|
|
||||||
a[name] {
|
|
||||||
color:#353833;
|
|
||||||
}
|
|
||||||
pre {
|
|
||||||
font-family:'DejaVu Sans Mono', monospace;
|
|
||||||
font-size:14px;
|
|
||||||
}
|
|
||||||
h1 {
|
|
||||||
font-size:20px;
|
|
||||||
}
|
|
||||||
h2 {
|
|
||||||
font-size:18px;
|
|
||||||
}
|
|
||||||
h3 {
|
|
||||||
font-size:16px;
|
|
||||||
}
|
|
||||||
h4 {
|
|
||||||
font-size:15px;
|
|
||||||
}
|
|
||||||
h5 {
|
|
||||||
font-size:14px;
|
|
||||||
}
|
|
||||||
h6 {
|
|
||||||
font-size:13px;
|
|
||||||
}
|
|
||||||
ul {
|
|
||||||
list-style-type:disc;
|
|
||||||
}
|
|
||||||
code, tt {
|
|
||||||
font-family:'DejaVu Sans Mono', monospace;
|
|
||||||
}
|
|
||||||
:not(h1, h2, h3, h4, h5, h6) > code,
|
|
||||||
:not(h1, h2, h3, h4, h5, h6) > tt {
|
|
||||||
font-size:14px;
|
|
||||||
padding-top:4px;
|
|
||||||
margin-top:8px;
|
|
||||||
line-height:1.4em;
|
|
||||||
}
|
|
||||||
dt code {
|
|
||||||
font-family:'DejaVu Sans Mono', monospace;
|
|
||||||
font-size:14px;
|
|
||||||
padding-top:4px;
|
|
||||||
}
|
|
||||||
.summary-table dt code {
|
|
||||||
font-family:'DejaVu Sans Mono', monospace;
|
|
||||||
font-size:14px;
|
|
||||||
vertical-align:top;
|
|
||||||
padding-top:4px;
|
|
||||||
}
|
|
||||||
sup {
|
|
||||||
font-size:8px;
|
|
||||||
}
|
|
||||||
button {
|
|
||||||
font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
|
|
||||||
font-size: 14px;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for HTML generated by javadoc.
|
|
||||||
*
|
|
||||||
* These are style classes that are used by the standard doclet to generate HTML documentation.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Styles for document title and copyright.
|
|
||||||
*/
|
|
||||||
.clear {
|
|
||||||
clear:both;
|
|
||||||
height:0;
|
|
||||||
overflow:hidden;
|
|
||||||
}
|
|
||||||
.about-language {
|
|
||||||
float:right;
|
|
||||||
padding:0 21px 8px 8px;
|
|
||||||
font-size:11px;
|
|
||||||
margin-top:-9px;
|
|
||||||
height:2.9em;
|
|
||||||
}
|
|
||||||
.legal-copy {
|
|
||||||
margin-left:.5em;
|
|
||||||
}
|
|
||||||
.tab {
|
|
||||||
background-color:#0066FF;
|
|
||||||
color:#ffffff;
|
|
||||||
padding:8px;
|
|
||||||
width:5em;
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for navigation bar.
|
|
||||||
*/
|
|
||||||
@media screen {
|
|
||||||
.flex-box {
|
|
||||||
position:fixed;
|
|
||||||
display:flex;
|
|
||||||
flex-direction:column;
|
|
||||||
height: 100%;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
.flex-header {
|
|
||||||
flex: 0 0 auto;
|
|
||||||
}
|
|
||||||
.flex-content {
|
|
||||||
flex: 1 1 auto;
|
|
||||||
overflow-y: auto;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.top-nav {
|
|
||||||
background-color:#4D7A97;
|
|
||||||
color:#FFFFFF;
|
|
||||||
float:left;
|
|
||||||
padding:0;
|
|
||||||
width:100%;
|
|
||||||
clear:right;
|
|
||||||
min-height:2.8em;
|
|
||||||
padding-top:10px;
|
|
||||||
overflow:hidden;
|
|
||||||
font-size:12px;
|
|
||||||
}
|
|
||||||
.sub-nav {
|
|
||||||
background-color:#dee3e9;
|
|
||||||
float:left;
|
|
||||||
width:100%;
|
|
||||||
overflow:hidden;
|
|
||||||
font-size:12px;
|
|
||||||
}
|
|
||||||
.sub-nav div {
|
|
||||||
clear:left;
|
|
||||||
float:left;
|
|
||||||
padding:0 0 5px 6px;
|
|
||||||
text-transform:uppercase;
|
|
||||||
}
|
|
||||||
.sub-nav .nav-list {
|
|
||||||
padding-top:5px;
|
|
||||||
}
|
|
||||||
ul.nav-list {
|
|
||||||
display:block;
|
|
||||||
margin:0 25px 0 0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
ul.sub-nav-list {
|
|
||||||
float:left;
|
|
||||||
margin:0 25px 0 0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
ul.nav-list li {
|
|
||||||
list-style:none;
|
|
||||||
float:left;
|
|
||||||
padding: 5px 6px;
|
|
||||||
text-transform:uppercase;
|
|
||||||
}
|
|
||||||
.sub-nav .nav-list-search {
|
|
||||||
float:right;
|
|
||||||
margin:0 0 0 0;
|
|
||||||
padding:5px 6px;
|
|
||||||
clear:none;
|
|
||||||
}
|
|
||||||
.nav-list-search label {
|
|
||||||
position:relative;
|
|
||||||
right:-16px;
|
|
||||||
}
|
|
||||||
ul.sub-nav-list li {
|
|
||||||
list-style:none;
|
|
||||||
float:left;
|
|
||||||
padding-top:10px;
|
|
||||||
}
|
|
||||||
.top-nav a:link, .top-nav a:active, .top-nav a:visited {
|
|
||||||
color:#FFFFFF;
|
|
||||||
text-decoration:none;
|
|
||||||
text-transform:uppercase;
|
|
||||||
}
|
|
||||||
.top-nav a:hover {
|
|
||||||
text-decoration:none;
|
|
||||||
color:#bb7a2a;
|
|
||||||
text-transform:uppercase;
|
|
||||||
}
|
|
||||||
.nav-bar-cell1-rev {
|
|
||||||
background-color:#F8981D;
|
|
||||||
color:#253441;
|
|
||||||
margin: auto 5px;
|
|
||||||
}
|
|
||||||
.skip-nav {
|
|
||||||
position:absolute;
|
|
||||||
top:auto;
|
|
||||||
left:-9999px;
|
|
||||||
overflow:hidden;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Hide navigation links and search box in print layout
|
|
||||||
*/
|
|
||||||
@media print {
|
|
||||||
ul.nav-list, div.sub-nav {
|
|
||||||
display:none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for page header and footer.
|
|
||||||
*/
|
|
||||||
.title {
|
|
||||||
color:#2c4557;
|
|
||||||
margin:10px 0;
|
|
||||||
}
|
|
||||||
.sub-title {
|
|
||||||
margin:5px 0 0 0;
|
|
||||||
}
|
|
||||||
.header ul {
|
|
||||||
margin:0 0 15px 0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
.header ul li, .footer ul li {
|
|
||||||
list-style:none;
|
|
||||||
font-size:13px;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for headings.
|
|
||||||
*/
|
|
||||||
body.class-declaration-page .summary h2,
|
|
||||||
body.class-declaration-page .details h2,
|
|
||||||
body.class-use-page h2,
|
|
||||||
body.module-declaration-page .block-list h2 {
|
|
||||||
font-style: italic;
|
|
||||||
padding:0;
|
|
||||||
margin:15px 0;
|
|
||||||
}
|
|
||||||
body.class-declaration-page .summary h3,
|
|
||||||
body.class-declaration-page .details h3,
|
|
||||||
body.class-declaration-page .summary .inherited-list h2 {
|
|
||||||
background-color:#dee3e9;
|
|
||||||
border:1px solid #d0d9e0;
|
|
||||||
margin:0 0 6px -8px;
|
|
||||||
padding:7px 5px;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for page layout containers.
|
|
||||||
*/
|
|
||||||
main {
|
|
||||||
clear:both;
|
|
||||||
padding:10px 20px;
|
|
||||||
position:relative;
|
|
||||||
}
|
|
||||||
dl.notes > dt {
|
|
||||||
font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
|
|
||||||
font-size:12px;
|
|
||||||
font-weight:bold;
|
|
||||||
margin:10px 0 0 0;
|
|
||||||
color:#4E4E4E;
|
|
||||||
}
|
|
||||||
dl.notes > dd {
|
|
||||||
margin:5px 10px 10px 0;
|
|
||||||
font-size:14px;
|
|
||||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
|
||||||
}
|
|
||||||
dl.name-value > dt {
|
|
||||||
margin-left:1px;
|
|
||||||
font-size:1.1em;
|
|
||||||
display:inline;
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
dl.name-value > dd {
|
|
||||||
margin:0 0 0 1px;
|
|
||||||
font-size:1.1em;
|
|
||||||
display:inline;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for lists.
|
|
||||||
*/
|
|
||||||
li.circle {
|
|
||||||
list-style:circle;
|
|
||||||
}
|
|
||||||
ul.horizontal li {
|
|
||||||
display:inline;
|
|
||||||
font-size:0.9em;
|
|
||||||
}
|
|
||||||
div.inheritance {
|
|
||||||
margin:0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
div.inheritance div.inheritance {
|
|
||||||
margin-left:2em;
|
|
||||||
}
|
|
||||||
ul.block-list,
|
|
||||||
ul.details-list,
|
|
||||||
ul.member-list,
|
|
||||||
ul.summary-list {
|
|
||||||
margin:10px 0 10px 0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
ul.block-list > li,
|
|
||||||
ul.details-list > li,
|
|
||||||
ul.member-list > li,
|
|
||||||
ul.summary-list > li {
|
|
||||||
list-style:none;
|
|
||||||
margin-bottom:15px;
|
|
||||||
line-height:1.4;
|
|
||||||
}
|
|
||||||
.summary-table dl, .summary-table dl dt, .summary-table dl dd {
|
|
||||||
margin-top:0;
|
|
||||||
margin-bottom:1px;
|
|
||||||
}
|
|
||||||
ul.see-list, ul.see-list-long {
|
|
||||||
padding-left: 0;
|
|
||||||
list-style: none;
|
|
||||||
}
|
|
||||||
ul.see-list li {
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
ul.see-list li:not(:last-child):after,
|
|
||||||
ul.see-list-long li:not(:last-child):after {
|
|
||||||
content: ", ";
|
|
||||||
white-space: pre-wrap;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for tables.
|
|
||||||
*/
|
|
||||||
.summary-table, .details-table {
|
|
||||||
width:100%;
|
|
||||||
border-spacing:0;
|
|
||||||
border-left:1px solid #EEE;
|
|
||||||
border-right:1px solid #EEE;
|
|
||||||
border-bottom:1px solid #EEE;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
.caption {
|
|
||||||
position:relative;
|
|
||||||
text-align:left;
|
|
||||||
background-repeat:no-repeat;
|
|
||||||
color:#253441;
|
|
||||||
font-weight:bold;
|
|
||||||
clear:none;
|
|
||||||
overflow:hidden;
|
|
||||||
padding:0;
|
|
||||||
padding-top:10px;
|
|
||||||
padding-left:1px;
|
|
||||||
margin:0;
|
|
||||||
white-space:pre;
|
|
||||||
}
|
|
||||||
.caption a:link, .caption a:visited {
|
|
||||||
color:#1f389c;
|
|
||||||
}
|
|
||||||
.caption a:hover,
|
|
||||||
.caption a:active {
|
|
||||||
color:#FFFFFF;
|
|
||||||
}
|
|
||||||
.caption span {
|
|
||||||
white-space:nowrap;
|
|
||||||
padding-top:5px;
|
|
||||||
padding-left:12px;
|
|
||||||
padding-right:12px;
|
|
||||||
padding-bottom:7px;
|
|
||||||
display:inline-block;
|
|
||||||
float:left;
|
|
||||||
background-color:#F8981D;
|
|
||||||
border: none;
|
|
||||||
height:16px;
|
|
||||||
}
|
|
||||||
div.table-tabs {
|
|
||||||
padding:10px 0 0 1px;
|
|
||||||
margin:0;
|
|
||||||
}
|
|
||||||
div.table-tabs > button {
|
|
||||||
border: none;
|
|
||||||
cursor: pointer;
|
|
||||||
padding: 5px 12px 7px 12px;
|
|
||||||
font-weight: bold;
|
|
||||||
margin-right: 3px;
|
|
||||||
}
|
|
||||||
div.table-tabs > button.active-table-tab {
|
|
||||||
background: #F8981D;
|
|
||||||
color: #253441;
|
|
||||||
}
|
|
||||||
div.table-tabs > button.table-tab {
|
|
||||||
background: #4D7A97;
|
|
||||||
color: #FFFFFF;
|
|
||||||
}
|
|
||||||
.two-column-summary {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
|
|
||||||
}
|
|
||||||
.three-column-summary {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto);
|
|
||||||
}
|
|
||||||
.four-column-summary {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto);
|
|
||||||
}
|
|
||||||
@media screen and (max-width: 600px) {
|
|
||||||
.two-column-summary {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: 1fr;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@media screen and (max-width: 800px) {
|
|
||||||
.three-column-summary {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
|
|
||||||
}
|
|
||||||
.three-column-summary .col-last {
|
|
||||||
grid-column-end: span 2;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@media screen and (max-width: 1000px) {
|
|
||||||
.four-column-summary {
|
|
||||||
display: grid;
|
|
||||||
grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
.summary-table > div, .details-table > div {
|
|
||||||
text-align:left;
|
|
||||||
padding: 8px 3px 3px 7px;
|
|
||||||
}
|
|
||||||
.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name {
|
|
||||||
vertical-align:top;
|
|
||||||
padding-right:0;
|
|
||||||
padding-top:8px;
|
|
||||||
padding-bottom:3px;
|
|
||||||
}
|
|
||||||
.table-header {
|
|
||||||
background:#dee3e9;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
.col-first, .col-first {
|
|
||||||
font-size:13px;
|
|
||||||
}
|
|
||||||
.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last {
|
|
||||||
font-size:13px;
|
|
||||||
}
|
|
||||||
.col-first, .col-second, .col-constructor-name {
|
|
||||||
vertical-align:top;
|
|
||||||
overflow: auto;
|
|
||||||
}
|
|
||||||
.col-last {
|
|
||||||
white-space:normal;
|
|
||||||
}
|
|
||||||
.col-first a:link, .col-first a:visited,
|
|
||||||
.col-second a:link, .col-second a:visited,
|
|
||||||
.col-first a:link, .col-first a:visited,
|
|
||||||
.col-second a:link, .col-second a:visited,
|
|
||||||
.col-constructor-name a:link, .col-constructor-name a:visited,
|
|
||||||
.col-summary-item-name a:link, .col-summary-item-name a:visited,
|
|
||||||
.constant-values-container a:link, .constant-values-container a:visited,
|
|
||||||
.all-classes-container a:link, .all-classes-container a:visited,
|
|
||||||
.all-packages-container a:link, .all-packages-container a:visited {
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
.table-sub-heading-color {
|
|
||||||
background-color:#EEEEFF;
|
|
||||||
}
|
|
||||||
.even-row-color, .even-row-color .table-header {
|
|
||||||
background-color:#FFFFFF;
|
|
||||||
}
|
|
||||||
.odd-row-color, .odd-row-color .table-header {
|
|
||||||
background-color:#EEEEEF;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for contents.
|
|
||||||
*/
|
|
||||||
.deprecated-content {
|
|
||||||
margin:0;
|
|
||||||
padding:10px 0;
|
|
||||||
}
|
|
||||||
div.block {
|
|
||||||
font-size:14px;
|
|
||||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
|
||||||
}
|
|
||||||
.col-last div {
|
|
||||||
padding-top:0;
|
|
||||||
}
|
|
||||||
.col-last a {
|
|
||||||
padding-bottom:3px;
|
|
||||||
}
|
|
||||||
.module-signature,
|
|
||||||
.package-signature,
|
|
||||||
.type-signature,
|
|
||||||
.member-signature {
|
|
||||||
font-family:'DejaVu Sans Mono', monospace;
|
|
||||||
font-size:14px;
|
|
||||||
margin:14px 0;
|
|
||||||
white-space: pre-wrap;
|
|
||||||
}
|
|
||||||
.module-signature,
|
|
||||||
.package-signature,
|
|
||||||
.type-signature {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
.member-signature .type-parameters-long,
|
|
||||||
.member-signature .parameters,
|
|
||||||
.member-signature .exceptions {
|
|
||||||
display: inline-block;
|
|
||||||
vertical-align: top;
|
|
||||||
white-space: pre;
|
|
||||||
}
|
|
||||||
.member-signature .type-parameters {
|
|
||||||
white-space: normal;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for formatting effect.
|
|
||||||
*/
|
|
||||||
.source-line-no {
|
|
||||||
color:green;
|
|
||||||
padding:0 30px 0 0;
|
|
||||||
}
|
|
||||||
h1.hidden {
|
|
||||||
visibility:hidden;
|
|
||||||
overflow:hidden;
|
|
||||||
font-size:10px;
|
|
||||||
}
|
|
||||||
.block {
|
|
||||||
display:block;
|
|
||||||
margin:0 10px 5px 0;
|
|
||||||
color:#474747;
|
|
||||||
}
|
|
||||||
.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link,
|
|
||||||
.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type,
|
|
||||||
.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
.deprecation-comment, .help-footnote, .preview-comment {
|
|
||||||
font-style:italic;
|
|
||||||
}
|
|
||||||
.deprecation-block {
|
|
||||||
font-size:14px;
|
|
||||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
|
||||||
border-style:solid;
|
|
||||||
border-width:thin;
|
|
||||||
border-radius:10px;
|
|
||||||
padding:10px;
|
|
||||||
margin-bottom:10px;
|
|
||||||
margin-right:10px;
|
|
||||||
display:inline-block;
|
|
||||||
}
|
|
||||||
.preview-block {
|
|
||||||
font-size:14px;
|
|
||||||
font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
|
|
||||||
border-style:solid;
|
|
||||||
border-width:thin;
|
|
||||||
border-radius:10px;
|
|
||||||
padding:10px;
|
|
||||||
margin-bottom:10px;
|
|
||||||
margin-right:10px;
|
|
||||||
display:inline-block;
|
|
||||||
}
|
|
||||||
div.block div.deprecation-comment {
|
|
||||||
font-style:normal;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles specific to HTML5 elements.
|
|
||||||
*/
|
|
||||||
main, nav, header, footer, section {
|
|
||||||
display:block;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Styles for javadoc search.
|
|
||||||
*/
|
|
||||||
.ui-autocomplete-category {
|
|
||||||
font-weight:bold;
|
|
||||||
font-size:15px;
|
|
||||||
padding:7px 0 7px 3px;
|
|
||||||
background-color:#4D7A97;
|
|
||||||
color:#FFFFFF;
|
|
||||||
}
|
|
||||||
.result-item {
|
|
||||||
font-size:13px;
|
|
||||||
}
|
|
||||||
.ui-autocomplete {
|
|
||||||
max-height:85%;
|
|
||||||
max-width:65%;
|
|
||||||
overflow-y:scroll;
|
|
||||||
overflow-x:scroll;
|
|
||||||
white-space:nowrap;
|
|
||||||
box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
|
|
||||||
}
|
|
||||||
ul.ui-autocomplete {
|
|
||||||
position:fixed;
|
|
||||||
z-index:999999;
|
|
||||||
}
|
|
||||||
ul.ui-autocomplete li {
|
|
||||||
float:left;
|
|
||||||
clear:both;
|
|
||||||
width:100%;
|
|
||||||
}
|
|
||||||
.result-highlight {
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
#search-input {
|
|
||||||
background-image:url('resources/glass.png');
|
|
||||||
background-size:13px;
|
|
||||||
background-repeat:no-repeat;
|
|
||||||
background-position:2px 3px;
|
|
||||||
padding-left:20px;
|
|
||||||
position:relative;
|
|
||||||
right:-18px;
|
|
||||||
width:400px;
|
|
||||||
}
|
|
||||||
#reset-button {
|
|
||||||
background-color: rgb(255,255,255);
|
|
||||||
background-image:url('resources/x.png');
|
|
||||||
background-position:center;
|
|
||||||
background-repeat:no-repeat;
|
|
||||||
background-size:12px;
|
|
||||||
border:0 none;
|
|
||||||
width:16px;
|
|
||||||
height:16px;
|
|
||||||
position:relative;
|
|
||||||
left:-4px;
|
|
||||||
top:-4px;
|
|
||||||
font-size:0px;
|
|
||||||
}
|
|
||||||
.watermark {
|
|
||||||
color:#545454;
|
|
||||||
}
|
|
||||||
.search-tag-desc-result {
|
|
||||||
font-style:italic;
|
|
||||||
font-size:11px;
|
|
||||||
}
|
|
||||||
.search-tag-holder-result {
|
|
||||||
font-style:italic;
|
|
||||||
font-size:12px;
|
|
||||||
}
|
|
||||||
.search-tag-result:target {
|
|
||||||
background-color:yellow;
|
|
||||||
}
|
|
||||||
.module-graph span {
|
|
||||||
display:none;
|
|
||||||
position:absolute;
|
|
||||||
}
|
|
||||||
.module-graph:hover span {
|
|
||||||
display:block;
|
|
||||||
margin: -100px 0 0 100px;
|
|
||||||
z-index: 1;
|
|
||||||
}
|
|
||||||
.inherited-list {
|
|
||||||
margin: 10px 0 10px 0;
|
|
||||||
}
|
|
||||||
section.class-description {
|
|
||||||
line-height: 1.4;
|
|
||||||
}
|
|
||||||
.summary section[class$="-summary"], .details section[class$="-details"],
|
|
||||||
.class-uses .detail, .serialized-class-details {
|
|
||||||
padding: 0px 20px 5px 10px;
|
|
||||||
border: 1px solid #ededed;
|
|
||||||
background-color: #f8f8f8;
|
|
||||||
}
|
|
||||||
.inherited-list, section[class$="-details"] .detail {
|
|
||||||
padding:0 0 5px 8px;
|
|
||||||
background-color:#ffffff;
|
|
||||||
border:none;
|
|
||||||
}
|
|
||||||
.vertical-separator {
|
|
||||||
padding: 0 5px;
|
|
||||||
}
|
|
||||||
ul.help-section-list {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
ul.help-subtoc > li {
|
|
||||||
display: inline-block;
|
|
||||||
padding-right: 5px;
|
|
||||||
font-size: smaller;
|
|
||||||
}
|
|
||||||
ul.help-subtoc > li::before {
|
|
||||||
content: "\2022" ;
|
|
||||||
padding-right:2px;
|
|
||||||
}
|
|
||||||
span.help-note {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
/*
|
|
||||||
* Indicator icon for external links.
|
|
||||||
*/
|
|
||||||
main a[href*="://"]::after {
|
|
||||||
content:"";
|
|
||||||
display:inline-block;
|
|
||||||
background-image:url('data:image/svg+xml; utf8, \
|
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" width="768" height="768">\
|
|
||||||
<path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \
|
|
||||||
132-240 240 120 120 240-240 132 132V0z" fill="%234a6782"/>\
|
|
||||||
</svg>');
|
|
||||||
background-size:100% 100%;
|
|
||||||
width:7px;
|
|
||||||
height:7px;
|
|
||||||
margin-left:2px;
|
|
||||||
margin-bottom:4px;
|
|
||||||
}
|
|
||||||
main a[href*="://"]:hover::after,
|
|
||||||
main a[href*="://"]:focus::after {
|
|
||||||
background-image:url('data:image/svg+xml; utf8, \
|
|
||||||
<svg xmlns="http://www.w3.org/2000/svg" width="768" height="768">\
|
|
||||||
<path d="M584 664H104V184h216V80H0v688h688V448H584zM384 0l132 \
|
|
||||||
132-240 240 120 120 240-240 132 132V0z" fill="%23bb7a2a"/>\
|
|
||||||
</svg>');
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Styles for user-provided tables.
|
|
||||||
*
|
|
||||||
* borderless:
|
|
||||||
* No borders, vertical margins, styled caption.
|
|
||||||
* This style is provided for use with existing doc comments.
|
|
||||||
* In general, borderless tables should not be used for layout purposes.
|
|
||||||
*
|
|
||||||
* plain:
|
|
||||||
* Plain borders around table and cells, vertical margins, styled caption.
|
|
||||||
* Best for small tables or for complex tables for tables with cells that span
|
|
||||||
* rows and columns, when the "striped" style does not work well.
|
|
||||||
*
|
|
||||||
* striped:
|
|
||||||
* Borders around the table and vertical borders between cells, striped rows,
|
|
||||||
* vertical margins, styled caption.
|
|
||||||
* Best for tables that have a header row, and a body containing a series of simple rows.
|
|
||||||
*/
|
|
||||||
|
|
||||||
table.borderless,
|
|
||||||
table.plain,
|
|
||||||
table.striped {
|
|
||||||
margin-top: 10px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
table.borderless > caption,
|
|
||||||
table.plain > caption,
|
|
||||||
table.striped > caption {
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: smaller;
|
|
||||||
}
|
|
||||||
table.borderless th, table.borderless td,
|
|
||||||
table.plain th, table.plain td,
|
|
||||||
table.striped th, table.striped td {
|
|
||||||
padding: 2px 5px;
|
|
||||||
}
|
|
||||||
table.borderless,
|
|
||||||
table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
|
|
||||||
table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
|
|
||||||
border: none;
|
|
||||||
}
|
|
||||||
table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
table.plain {
|
|
||||||
border-collapse: collapse;
|
|
||||||
border: 1px solid black;
|
|
||||||
}
|
|
||||||
table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
|
|
||||||
table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
|
|
||||||
border: 1px solid black;
|
|
||||||
}
|
|
||||||
table.striped {
|
|
||||||
border-collapse: collapse;
|
|
||||||
border: 1px solid black;
|
|
||||||
}
|
|
||||||
table.striped > thead {
|
|
||||||
background-color: #E3E3E3;
|
|
||||||
}
|
|
||||||
table.striped > thead > tr > th, table.striped > thead > tr > td {
|
|
||||||
border: 1px solid black;
|
|
||||||
}
|
|
||||||
table.striped > tbody > tr:nth-child(even) {
|
|
||||||
background-color: #EEE
|
|
||||||
}
|
|
||||||
table.striped > tbody > tr:nth-child(odd) {
|
|
||||||
background-color: #FFF
|
|
||||||
}
|
|
||||||
table.striped > tbody > tr > th, table.striped > tbody > tr > td {
|
|
||||||
border-left: 1px solid black;
|
|
||||||
border-right: 1px solid black;
|
|
||||||
}
|
|
||||||
table.striped > tbody > tr > th {
|
|
||||||
font-weight: normal;
|
|
||||||
}
|
|
||||||
/**
|
|
||||||
* Tweak font sizes and paddings for small screens.
|
|
||||||
*/
|
|
||||||
@media screen and (max-width: 1050px) {
|
|
||||||
#search-input {
|
|
||||||
width: 300px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@media screen and (max-width: 800px) {
|
|
||||||
#search-input {
|
|
||||||
width: 200px;
|
|
||||||
}
|
|
||||||
.top-nav,
|
|
||||||
.bottom-nav {
|
|
||||||
font-size: 11px;
|
|
||||||
padding-top: 6px;
|
|
||||||
}
|
|
||||||
.sub-nav {
|
|
||||||
font-size: 11px;
|
|
||||||
}
|
|
||||||
.about-language {
|
|
||||||
padding-right: 16px;
|
|
||||||
}
|
|
||||||
ul.nav-list li,
|
|
||||||
.sub-nav .nav-list-search {
|
|
||||||
padding: 6px;
|
|
||||||
}
|
|
||||||
ul.sub-nav-list li {
|
|
||||||
padding-top: 5px;
|
|
||||||
}
|
|
||||||
main {
|
|
||||||
padding: 10px;
|
|
||||||
}
|
|
||||||
.summary section[class$="-summary"], .details section[class$="-details"],
|
|
||||||
.class-uses .detail, .serialized-class-details {
|
|
||||||
padding: 0 8px 5px 8px;
|
|
||||||
}
|
|
||||||
body {
|
|
||||||
-webkit-text-size-adjust: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@media screen and (max-width: 500px) {
|
|
||||||
#search-input {
|
|
||||||
width: 150px;
|
|
||||||
}
|
|
||||||
.top-nav,
|
|
||||||
.bottom-nav {
|
|
||||||
font-size: 10px;
|
|
||||||
}
|
|
||||||
.sub-nav {
|
|
||||||
font-size: 10px;
|
|
||||||
}
|
|
||||||
.about-language {
|
|
||||||
font-size: 10px;
|
|
||||||
padding-right: 12px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,493 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>SwerveController</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib, class: SwerveController">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib</a></div>
|
|
||||||
<h1 title="Class SwerveController" class="title">Class SwerveController</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">swervelib.SwerveController</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveController</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">Controller class used to convert raw inputs into robot speeds.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>edu.wpi.first.math.filter.SlewRateLimiter</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#angleLimiter" class="member-name-link">angleLimiter</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for angular movement in radians/second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#config" class="member-name-link">config</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
|
|
||||||
robot heading, and deadband for heading joystick.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#lastAngleScalar" class="member-name-link">lastAngleScalar</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Last angle as a scalar [-1,1] the robot was set to.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>final edu.wpi.first.math.controller.PIDController</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#thetaController" class="member-name-link">thetaController</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">PID Controller for the robot heading.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>edu.wpi.first.math.filter.SlewRateLimiter</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#xLimiter" class="member-name-link">xLimiter</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for movement in the X direction in meters/second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>edu.wpi.first.math.filter.SlewRateLimiter</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#yLimiter" class="member-name-link">yLimiter</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for movement in the Y direction in meters/second.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.parser.SwerveControllerConfiguration)" class="member-name-link">SwerveController</a><wbr>(<a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> cfg)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot based on controller
|
|
||||||
input.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addSlewRateLimiters(edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter)" class="member-name-link">addSlewRateLimiters</a><wbr>(edu.wpi.first.math.filter.SlewRateLimiter x,
|
|
||||||
edu.wpi.first.math.filter.SlewRateLimiter y,
|
|
||||||
edu.wpi.first.math.filter.SlewRateLimiter angle)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Add slew rate limiters to all controls.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getJoystickAngle(double,double)" class="member-name-link">getJoystickAngle</a><wbr>(double headingX,
|
|
||||||
double headingY)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the angle in radians based off of the heading joysticks.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRawTargetSpeeds(double,double,double)" class="member-name-link">getRawTargetSpeeds</a><wbr>(double xSpeed,
|
|
||||||
double ySpeed,
|
|
||||||
double omega)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRawTargetSpeeds(double,double,double,double)" class="member-name-link">getRawTargetSpeeds</a><wbr>(double xSpeed,
|
|
||||||
double ySpeed,
|
|
||||||
double targetHeadingAngleRadians,
|
|
||||||
double currentHeadingAngleRadians)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double xInput,
|
|
||||||
double yInput,
|
|
||||||
double angle,
|
|
||||||
double currentHeadingAngleRadians,
|
|
||||||
double maxSpeed)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.ChassisSpeeds</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetSpeeds(double,double,double,double,double,double)" class="member-name-link">getTargetSpeeds</a><wbr>(double xInput,
|
|
||||||
double yInput,
|
|
||||||
double headingX,
|
|
||||||
double headingY,
|
|
||||||
double currentHeadingAngleRadians,
|
|
||||||
double maxSpeed)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 2 joysticks.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.math.geometry.Translation2d</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTranslation2d(edu.wpi.first.math.kinematics.ChassisSpeeds)" class="member-name-link">getTranslation2d</a><wbr>(edu.wpi.first.math.kinematics.ChassisSpeeds speeds)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Helper function to get the <code>Translation2d</code> of the chassis speeds given the <code>ChassisSpeeds</code>.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#headingCalculate(double,double)" class="member-name-link">headingCalculate</a><wbr>(double currentHeadingAngleRadians,
|
|
||||||
double targetHeadingAngleRadians)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Calculate the angular velocity given the current and target heading angle in radians.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMaximumAngularVelocity(double)" class="member-name-link">setMaximumAngularVelocity</a><wbr>(double angularVelocity)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set a new maximum angular velocity that is different from the auto-generated one.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#withinHypotDeadband(double,double)" class="member-name-link">withinHypotDeadband</a><wbr>(double x,
|
|
||||||
double y)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Calculate the hypot deadband and check if the joystick is within it.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="config">
|
|
||||||
<h3>config</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a></span> <span class="element-name">config</span></div>
|
|
||||||
<div class="block"><a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> object storing data to generate the <code>PIDController</code> for controlling the
|
|
||||||
robot heading, and deadband for heading joystick.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="thetaController">
|
|
||||||
<h3>thetaController</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">edu.wpi.first.math.controller.PIDController</span> <span class="element-name">thetaController</span></div>
|
|
||||||
<div class="block">PID Controller for the robot heading.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="lastAngleScalar">
|
|
||||||
<h3>lastAngleScalar</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">lastAngleScalar</span></div>
|
|
||||||
<div class="block">Last angle as a scalar [-1,1] the robot was set to.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="xLimiter">
|
|
||||||
<h3>xLimiter</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.filter.SlewRateLimiter</span> <span class="element-name">xLimiter</span></div>
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for movement in the X direction in meters/second.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="yLimiter">
|
|
||||||
<h3>yLimiter</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.filter.SlewRateLimiter</span> <span class="element-name">yLimiter</span></div>
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for movement in the Y direction in meters/second.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="angleLimiter">
|
|
||||||
<h3>angleLimiter</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.filter.SlewRateLimiter</span> <span class="element-name">angleLimiter</span></div>
|
|
||||||
<div class="block"><code>SlewRateLimiter</code> for angular movement in radians/second.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(swervelib.parser.SwerveControllerConfiguration)">
|
|
||||||
<h3>SwerveController</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveController</span><wbr><span class="parameters">(<a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser">SwerveControllerConfiguration</a> cfg)</span></div>
|
|
||||||
<div class="block">Construct the SwerveController object which is used for determining the speeds of the robot based on controller
|
|
||||||
input.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>cfg</code> - <a href="parser/SwerveControllerConfiguration.html" title="class in swervelib.parser"><code>SwerveControllerConfiguration</code></a> containing the PIDF variables for the heading PIDF.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getTranslation2d(edu.wpi.first.math.kinematics.ChassisSpeeds)">
|
|
||||||
<h3>getTranslation2d</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.math.geometry.Translation2d</span> <span class="element-name">getTranslation2d</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.ChassisSpeeds speeds)</span></div>
|
|
||||||
<div class="block">Helper function to get the <code>Translation2d</code> of the chassis speeds given the <code>ChassisSpeeds</code>.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>speeds</code> - Chassis speeds.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>Translation2d</code> of the speed the robot is going in.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="addSlewRateLimiters(edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter,edu.wpi.first.math.filter.SlewRateLimiter)">
|
|
||||||
<h3>addSlewRateLimiters</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">addSlewRateLimiters</span><wbr><span class="parameters">(edu.wpi.first.math.filter.SlewRateLimiter x,
|
|
||||||
edu.wpi.first.math.filter.SlewRateLimiter y,
|
|
||||||
edu.wpi.first.math.filter.SlewRateLimiter angle)</span></div>
|
|
||||||
<div class="block">Add slew rate limiters to all controls. This prevents the robot from ramping up too much. To disable a
|
|
||||||
<code>SlewRateLimiter</code> set the desired one to null.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>x</code> - The <code>SlewRateLimiter</code> for the X velocity in meters/second.</dd>
|
|
||||||
<dd><code>y</code> - The <code>SlewRateLimiter</code> for the Y velocity in meters/second.</dd>
|
|
||||||
<dd><code>angle</code> - The <code>SlewRateLimiter</code> for the angular velocity in radians/second.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="withinHypotDeadband(double,double)">
|
|
||||||
<h3>withinHypotDeadband</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">withinHypotDeadband</span><wbr><span class="parameters">(double x,
|
|
||||||
double y)</span></div>
|
|
||||||
<div class="block">Calculate the hypot deadband and check if the joystick is within it.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>x</code> - The x value for the joystick in which the deadband should be applied.</dd>
|
|
||||||
<dd><code>y</code> - The y value for the joystick in which the deadband should be applied.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Whether the values are within the deadband from
|
|
||||||
<a href="parser/SwerveControllerConfiguration.html#angleJoyStickRadiusDeadband"><code>SwerveControllerConfiguration.angleJoyStickRadiusDeadband</code></a>.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getTargetSpeeds(double,double,double,double,double)">
|
|
||||||
<h3>getTargetSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getTargetSpeeds</span><wbr><span class="parameters">(double xInput,
|
|
||||||
double yInput,
|
|
||||||
double angle,
|
|
||||||
double currentHeadingAngleRadians,
|
|
||||||
double maxSpeed)</span></div>
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction. X = xInput * maxSpeed</dd>
|
|
||||||
<dd><code>yInput</code> - Y joystick input for the robot to move in the Y direction. Y = yInput *
|
|
||||||
maxSpeed;</dd>
|
|
||||||
<dd><code>angle</code> - The desired angle of the robot in radians.</dd>
|
|
||||||
<dd><code>currentHeadingAngleRadians</code> - The current robot heading in radians.</dd>
|
|
||||||
<dd><code>maxSpeed</code> - Maximum speed in meters per second.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>ChassisSpeeds</code> which can be sent to the Swerve Drive.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getJoystickAngle(double,double)">
|
|
||||||
<h3>getJoystickAngle</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getJoystickAngle</span><wbr><span class="parameters">(double headingX,
|
|
||||||
double headingY)</span></div>
|
|
||||||
<div class="block">Get the angle in radians based off of the heading joysticks.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>headingX</code> - X joystick which controls the angle of the robot.</dd>
|
|
||||||
<dd><code>headingY</code> - Y joystick which controls the angle of the robot.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>angle in radians from the joystick.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getTargetSpeeds(double,double,double,double,double,double)">
|
|
||||||
<h3>getTargetSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getTargetSpeeds</span><wbr><span class="parameters">(double xInput,
|
|
||||||
double yInput,
|
|
||||||
double headingX,
|
|
||||||
double headingY,
|
|
||||||
double currentHeadingAngleRadians,
|
|
||||||
double maxSpeed)</span></div>
|
|
||||||
<div class="block">Get the chassis speeds based on controller input of 2 joysticks. One for speeds in which direction. The other for
|
|
||||||
the angle of the robot.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>xInput</code> - X joystick input for the robot to move in the X direction.</dd>
|
|
||||||
<dd><code>yInput</code> - Y joystick input for the robot to move in the Y direction.</dd>
|
|
||||||
<dd><code>headingX</code> - X joystick which controls the angle of the robot.</dd>
|
|
||||||
<dd><code>headingY</code> - Y joystick which controls the angle of the robot.</dd>
|
|
||||||
<dd><code>currentHeadingAngleRadians</code> - The current robot heading in radians.</dd>
|
|
||||||
<dd><code>maxSpeed</code> - Maximum speed of the drive motors in meters per second, multiplier of the xInput
|
|
||||||
and yInput.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>ChassisSpeeds</code> which can be sent to the Swerve Drive.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getRawTargetSpeeds(double,double,double)">
|
|
||||||
<h3>getRawTargetSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getRawTargetSpeeds</span><wbr><span class="parameters">(double xSpeed,
|
|
||||||
double ySpeed,
|
|
||||||
double omega)</span></div>
|
|
||||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>xSpeed</code> - X speed in meters per second.</dd>
|
|
||||||
<dd><code>ySpeed</code> - Y speed in meters per second.</dd>
|
|
||||||
<dd><code>omega</code> - Angular velocity in radians/second.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>ChassisSpeeds</code> the robot should move to.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getRawTargetSpeeds(double,double,double,double)">
|
|
||||||
<h3>getRawTargetSpeeds</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.ChassisSpeeds</span> <span class="element-name">getRawTargetSpeeds</span><wbr><span class="parameters">(double xSpeed,
|
|
||||||
double ySpeed,
|
|
||||||
double targetHeadingAngleRadians,
|
|
||||||
double currentHeadingAngleRadians)</span></div>
|
|
||||||
<div class="block">Get the <code>ChassisSpeeds</code> based of raw speeds desired in meters/second and heading in radians.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>xSpeed</code> - X speed in meters per second.</dd>
|
|
||||||
<dd><code>ySpeed</code> - Y speed in meters per second.</dd>
|
|
||||||
<dd><code>targetHeadingAngleRadians</code> - Target heading in radians.</dd>
|
|
||||||
<dd><code>currentHeadingAngleRadians</code> - Current heading in radians.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>ChassisSpeeds</code> the robot should move to.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="headingCalculate(double,double)">
|
|
||||||
<h3>headingCalculate</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">headingCalculate</span><wbr><span class="parameters">(double currentHeadingAngleRadians,
|
|
||||||
double targetHeadingAngleRadians)</span></div>
|
|
||||||
<div class="block">Calculate the angular velocity given the current and target heading angle in radians.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>currentHeadingAngleRadians</code> - The current heading of the robot in radians.</dd>
|
|
||||||
<dd><code>targetHeadingAngleRadians</code> - The target heading of the robot in radians.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Angular velocity in radians per second.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setMaximumAngularVelocity(double)">
|
|
||||||
<h3>setMaximumAngularVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMaximumAngularVelocity</span><wbr><span class="parameters">(double angularVelocity)</span></div>
|
|
||||||
<div class="block">Set a new maximum angular velocity that is different from the auto-generated one. Modified the
|
|
||||||
<a href="parser/SwerveControllerConfiguration.html#maxAngularVelocity"><code>SwerveControllerConfiguration.maxAngularVelocity</code></a> field which is used in the <a href="SwerveController.html" title="class in swervelib"><code>SwerveController</code></a> class
|
|
||||||
for <code>ChassisSpeeds</code> generation.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>angularVelocity</code> - Angular velocity in radians per second.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,615 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>SwerveDriveTest</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib, class: SwerveDriveTest">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib</a></div>
|
|
||||||
<h1 title="Class SwerveDriveTest" class="title">Class SwerveDriveTest</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">swervelib.SwerveDriveTest</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveDriveTest</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">Class to perform tests on the swerve drive.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Angle></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#m_anglePosition" class="member-name-link">m_anglePosition</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Tracks the rotations of an angular motor</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Angle>></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#m_angVelocity" class="member-name-link">m_angVelocity</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Tracks the velocity of an angular motor</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Voltage></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#m_appliedVoltage" class="member-name-link">m_appliedVoltage</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Tracks the voltage being applied to a motor</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Distance></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#m_distance" class="member-name-link">m_distance</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Tracks the distance travelled of a position motor</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private static final edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Distance>></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#m_velocity" class="member-name-link">m_velocity</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Tracks the velocity of a positional motor</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SwerveDriveTest</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#angleModules(swervelib.SwerveDrive,edu.wpi.first.math.geometry.Rotation2d)" class="member-name-link">angleModules</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
edu.wpi.first.math.geometry.Rotation2d moduleAngle)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the angle of the modules to a given <code>Rotation2d</code></div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#centerModules(swervelib.SwerveDrive)" class="member-name-link">centerModules</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the modules to center to 0.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createConfigCustomTimeout(double)" class="member-name-link">createConfigCustomTimeout</a><wbr>(double timeout)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Creates a SysIdRoutine.Config with a custom final timeout</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findCouplingRatio(swervelib.SwerveDrive,double,boolean)" class="member-name-link">findCouplingRatio</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double volts,
|
|
||||||
boolean automatic)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Find the coupling ratio for all modules.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#findDriveMotorKV(swervelib.SwerveDrive,double,double,double)" class="member-name-link">findDriveMotorKV</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double minMovement,
|
|
||||||
double testDelaySeconds,
|
|
||||||
double maxVolts)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Find the minimum amount of power required to move the swerve drive motors.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.Command</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#generateSysIdCommand(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine,double,double,double)" class="member-name-link">generateSysIdCommand</a><wbr>(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine sysIdRoutine,
|
|
||||||
double delay,
|
|
||||||
double quasiTimeout,
|
|
||||||
double dynamicTimeout)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Creates a command that can be mapped to a button or other trigger.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logAngularMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logAngularMotorActivity</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logAngularMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorDutyCycle</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logAngularMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logAngularMotorVoltage</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logDriveMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)" class="member-name-link">logDriveMotorActivity</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Logs power, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logDriveMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorDutyCycle</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Logs output, position and velocuty info form the drive motor to the SysIdRoutineLog <br/> Although SysIdRoutine
|
|
||||||
expects to be logging Voltage, this function logs in Duty-Cycle (percent output) because it results in correctly
|
|
||||||
adjusted values in the analysis for use in this library.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#logDriveMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)" class="member-name-link">logDriveMotorVoltage</a><wbr>(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Logs voltage, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerAngleMotorsDutyCycle(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotorsDutyCycle</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double percentage)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Power the angle motors for the swerve drive to a set percentage.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerAngleMotorsVoltage(swervelib.SwerveDrive,double)" class="member-name-link">powerAngleMotorsVoltage</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double volts)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Power the angle motors for the swerve drive to a set voltage.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerDriveMotorsDutyCycle(swervelib.SwerveDrive,double)" class="member-name-link">powerDriveMotorsDutyCycle</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double percentage)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Power the drive motors for the swerve drive to a set duty cycle percentage.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#powerDriveMotorsVoltage(swervelib.SwerveDrive,double)" class="member-name-link">powerDriveMotorsVoltage</a><wbr>(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double volts)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Power the drive motors for the swerve drive to a set voltage.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setAngleSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive)" class="member-name-link">setAngleSysIdRoutine</a><wbr>(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
|
||||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
|
||||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets up the SysId runner and logger for the angle motors</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setDriveSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive,double)" class="member-name-link">setDriveSysIdRoutine</a><wbr>(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
|
||||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
|
||||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double maxVolts)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets up the SysId runner and logger for the drive motors</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="m_appliedVoltage">
|
|
||||||
<h3>m_appliedVoltage</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Voltage></span> <span class="element-name">m_appliedVoltage</span></div>
|
|
||||||
<div class="block">Tracks the voltage being applied to a motor</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="m_distance">
|
|
||||||
<h3>m_distance</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Distance></span> <span class="element-name">m_distance</span></div>
|
|
||||||
<div class="block">Tracks the distance travelled of a position motor</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="m_velocity">
|
|
||||||
<h3>m_velocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Distance>></span> <span class="element-name">m_velocity</span></div>
|
|
||||||
<div class="block">Tracks the velocity of a positional motor</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="m_anglePosition">
|
|
||||||
<h3>m_anglePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Angle></span> <span class="element-name">m_anglePosition</span></div>
|
|
||||||
<div class="block">Tracks the rotations of an angular motor</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="m_angVelocity">
|
|
||||||
<h3>m_angVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">edu.wpi.first.units.MutableMeasure<edu.wpi.first.units.Velocity<edu.wpi.first.units.Angle>></span> <span class="element-name">m_angVelocity</span></div>
|
|
||||||
<div class="block">Tracks the velocity of an angular motor</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>SwerveDriveTest</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveDriveTest</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="angleModules(swervelib.SwerveDrive,edu.wpi.first.math.geometry.Rotation2d)">
|
|
||||||
<h3>angleModules</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">angleModules</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
edu.wpi.first.math.geometry.Rotation2d moduleAngle)</span></div>
|
|
||||||
<div class="block">Set the angle of the modules to a given <code>Rotation2d</code></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to use.</dd>
|
|
||||||
<dd><code>moduleAngle</code> - <code>Rotation2d</code> to set every module to.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="powerDriveMotorsDutyCycle(swervelib.SwerveDrive,double)">
|
|
||||||
<h3>powerDriveMotorsDutyCycle</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">powerDriveMotorsDutyCycle</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double percentage)</span></div>
|
|
||||||
<div class="block">Power the drive motors for the swerve drive to a set duty cycle percentage.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to control.</dd>
|
|
||||||
<dd><code>percentage</code> - Duty cycle percentage of voltage to send to drive motors.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="powerAngleMotorsDutyCycle(swervelib.SwerveDrive,double)">
|
|
||||||
<h3>powerAngleMotorsDutyCycle</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">powerAngleMotorsDutyCycle</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double percentage)</span></div>
|
|
||||||
<div class="block">Power the angle motors for the swerve drive to a set percentage.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to control.</dd>
|
|
||||||
<dd><code>percentage</code> - DutyCycle percentage to send to angle motors.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="powerDriveMotorsVoltage(swervelib.SwerveDrive,double)">
|
|
||||||
<h3>powerDriveMotorsVoltage</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">powerDriveMotorsVoltage</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double volts)</span></div>
|
|
||||||
<div class="block">Power the drive motors for the swerve drive to a set voltage.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to control.</dd>
|
|
||||||
<dd><code>volts</code> - DutyCycle percentage of voltage to send to drive motors.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="powerAngleMotorsVoltage(swervelib.SwerveDrive,double)">
|
|
||||||
<h3>powerAngleMotorsVoltage</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">powerAngleMotorsVoltage</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double volts)</span></div>
|
|
||||||
<div class="block">Power the angle motors for the swerve drive to a set voltage.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to control.</dd>
|
|
||||||
<dd><code>volts</code> - Voltage to send to angle motors.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="centerModules(swervelib.SwerveDrive)">
|
|
||||||
<h3>centerModules</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">centerModules</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive)</span></div>
|
|
||||||
<div class="block">Set the modules to center to 0.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - Swerve Drive to control.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="findDriveMotorKV(swervelib.SwerveDrive,double,double,double)">
|
|
||||||
<h3>findDriveMotorKV</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">findDriveMotorKV</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double minMovement,
|
|
||||||
double testDelaySeconds,
|
|
||||||
double maxVolts)</span></div>
|
|
||||||
<div class="block">Find the minimum amount of power required to move the swerve drive motors.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to control.</dd>
|
|
||||||
<dd><code>minMovement</code> - Minimum amount of movement to drive motors.</dd>
|
|
||||||
<dd><code>testDelaySeconds</code> - Time in seconds for the motor to move.</dd>
|
|
||||||
<dd><code>maxVolts</code> - The maximum voltage to send to drive motors.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>minimum voltage required.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="findCouplingRatio(swervelib.SwerveDrive,double,boolean)">
|
|
||||||
<h3>findCouplingRatio</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">findCouplingRatio</span><wbr><span class="parameters">(<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double volts,
|
|
||||||
boolean automatic)</span></div>
|
|
||||||
<div class="block">Find the coupling ratio for all modules.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>swerveDrive</code> - <a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> to operate with.</dd>
|
|
||||||
<dd><code>volts</code> - Voltage to send to angle motors to spin.</dd>
|
|
||||||
<dd><code>automatic</code> - Attempt to automatically spin the modules.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Average coupling ratio.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="createConfigCustomTimeout(double)">
|
|
||||||
<h3>createConfigCustomTimeout</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config</span> <span class="element-name">createConfigCustomTimeout</span><wbr><span class="parameters">(double timeout)</span></div>
|
|
||||||
<div class="block">Creates a SysIdRoutine.Config with a custom final timeout</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>timeout</code> - - the most a SysIdRoutine should run</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>A custom SysIdRoutine.Config</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="logDriveMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
|
||||||
<h3>logDriveMotorDutyCycle</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logDriveMotorDutyCycle</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
|
||||||
<div class="block">Logs output, position and velocuty info form the drive motor to the SysIdRoutineLog <br/> Although SysIdRoutine
|
|
||||||
expects to be logging Voltage, this function logs in Duty-Cycle (percent output) because it results in correctly
|
|
||||||
adjusted values in the analysis for use in this library.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
|
||||||
<dd><code>log</code> - - the logger</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="logDriveMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
|
||||||
<h3>logDriveMotorVoltage</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logDriveMotorVoltage</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
|
||||||
<div class="block">Logs voltage, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
|
||||||
<dd><code>log</code> - - the logger</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="logDriveMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)">
|
|
||||||
<h3>logDriveMotorActivity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logDriveMotorActivity</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</span></div>
|
|
||||||
<div class="block">Logs power, position and velocuty info form the drive motor to the SysIdRoutineLog</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
|
||||||
<dd><code>log</code> - - the logger</dd>
|
|
||||||
<dd><code>powerSupplied</code> - - a functional supplier of the power to be logged</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setDriveSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive,double)">
|
|
||||||
<h3>setDriveSysIdRoutine</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</span> <span class="element-name">setDriveSysIdRoutine</span><wbr><span class="parameters">(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
|
||||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
|
||||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive,
|
|
||||||
double maxVolts)</span></div>
|
|
||||||
<div class="block">Sets up the SysId runner and logger for the drive motors</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>config</code> - - The SysIdRoutine.Config to use</dd>
|
|
||||||
<dd><code>swerveSubsystem</code> - - the subsystem to add to requirements</dd>
|
|
||||||
<dd><code>swerveDrive</code> - - the SwerveDrive from which to access motor info</dd>
|
|
||||||
<dd><code>maxVolts</code> - - The maximum voltage that should be applied to the drive motors.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>A SysIdRoutine runner</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="logAngularMotorDutyCycle(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
|
||||||
<h3>logAngularMotorDutyCycle</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logAngularMotorDutyCycle</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog. <br/> Although SysIdRoutine expects to be logging Voltage,
|
|
||||||
this function logs in Duty-Cycle (percent output) because it results in correctly adjusted values in the analysis
|
|
||||||
for use in this library.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
|
||||||
<dd><code>log</code> - - the logger</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="logAngularMotorVoltage(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog)">
|
|
||||||
<h3>logAngularMotorVoltage</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logAngularMotorVoltage</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log)</span></div>
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
|
||||||
<dd><code>log</code> - - the logger</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="logAngularMotorActivity(swervelib.SwerveModule,edu.wpi.first.wpilibj.sysid.SysIdRoutineLog,java.util.function.Supplier)">
|
|
||||||
<h3>logAngularMotorActivity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">logAngularMotorActivity</span><wbr><span class="parameters">(<a href="SwerveModule.html" title="class in swervelib">SwerveModule</a> module,
|
|
||||||
edu.wpi.first.wpilibj.sysid.SysIdRoutineLog log,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>> powerSupplied)</span></div>
|
|
||||||
<div class="block">Logs info about the angle motor to the SysIdRoutineLog</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>module</code> - - the swerve module being logged</dd>
|
|
||||||
<dd><code>log</code> - - the logger</dd>
|
|
||||||
<dd><code>powerSupplied</code> - - a functional supplier of the power to be logged</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAngleSysIdRoutine(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config,edu.wpi.first.wpilibj2.command.SubsystemBase,swervelib.SwerveDrive)">
|
|
||||||
<h3>setAngleSysIdRoutine</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine</span> <span class="element-name">setAngleSysIdRoutine</span><wbr><span class="parameters">(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine.Config config,
|
|
||||||
edu.wpi.first.wpilibj2.command.SubsystemBase swerveSubsystem,
|
|
||||||
<a href="SwerveDrive.html" title="class in swervelib">SwerveDrive</a> swerveDrive)</span></div>
|
|
||||||
<div class="block">Sets up the SysId runner and logger for the angle motors</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>config</code> - - The SysIdRoutine.Config to use</dd>
|
|
||||||
<dd><code>swerveSubsystem</code> - - the subsystem to add to requirements</dd>
|
|
||||||
<dd><code>swerveDrive</code> - - the SwerveDrive from which to access motor info</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>A SysIdRoutineRunner</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="generateSysIdCommand(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine,double,double,double)">
|
|
||||||
<h3>generateSysIdCommand</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">edu.wpi.first.wpilibj2.command.Command</span> <span class="element-name">generateSysIdCommand</span><wbr><span class="parameters">(edu.wpi.first.wpilibj2.command.sysid.SysIdRoutine sysIdRoutine,
|
|
||||||
double delay,
|
|
||||||
double quasiTimeout,
|
|
||||||
double dynamicTimeout)</span></div>
|
|
||||||
<div class="block">Creates a command that can be mapped to a button or other trigger. Delays can be set to customize the length of
|
|
||||||
each part of the SysId Routine</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>sysIdRoutine</code> - - The Sys Id routine runner</dd>
|
|
||||||
<dd><code>delay</code> - - seconds between each portion to allow motors to spin down, etc...</dd>
|
|
||||||
<dd><code>quasiTimeout</code> - - seconds to run the Quasistatic routines, so robot doesn't get too far</dd>
|
|
||||||
<dd><code>dynamicTimeout</code> - - seconds to run the Dynamic routines, 2-3 secs should be enough</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>A command that can be mapped to a button or other trigger</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,964 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>SwerveModule</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib, class: SwerveModule">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib</a></div>
|
|
||||||
<h1 title="Class SwerveModule" class="title">Class SwerveModule</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">swervelib.SwerveModule</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SwerveModule</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">The Swerve Module class which represents and controls Swerve Modules for the swerve drive.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#absoluteEncoder" class="member-name-link">absoluteEncoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Absolute encoder for swerve drive.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#absoluteEncoderIssueName" class="member-name-link">absoluteEncoderIssueName</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">NT3 Absolute encoder read issue.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#absolutePositionCache" class="member-name-link">absolutePositionCache</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Absolute encoder position cache.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#adjAbsoluteAngleName" class="member-name-link">adjAbsoluteAngleName</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">NT3 Adjusted Absolute angle publisher for the absolute encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#angleMotor" class="member-name-link">angleMotor</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Swerve Motors.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#angleOffset" class="member-name-link">angleOffset</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Angle offset from the absolute encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#antiJitterEnabled" class="member-name-link">antiJitterEnabled</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Anti-Jitter AKA auto-centering disabled.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>final <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#configuration" class="member-name-link">configuration</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Swerve module configuration options.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#driveMotor" class="member-name-link">driveMotor</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Swerve Motors.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.controller.SimpleMotorFeedforward</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#driveMotorFeedforward" class="member-name-link">driveMotorFeedforward</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Feedforward for the drive motor during closed loop control.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#drivePositionCache" class="member-name-link">drivePositionCache</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Drive motor position cache.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>final <a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#driveVelocityCache" class="member-name-link">driveVelocityCache</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Drive motor velocity cache.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#encoderOffsetWarning" class="member-name-link">encoderOffsetWarning</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#lastState" class="member-name-link">lastState</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Last swerve module state applied.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#maxSpeed" class="member-name-link">maxSpeed</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Maximum speed of the drive motors in meters per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>final int</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#moduleNumber" class="member-name-link">moduleNumber</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Module number for kinematics, usually 0 to 3.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#noEncoderWarning" class="member-name-link">noEncoderWarning</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#rawAbsoluteAngleName" class="member-name-link">rawAbsoluteAngleName</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">NT3 Raw Absolute Angle publisher for the absolute encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#rawAngleName" class="member-name-link">rawAngleName</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">NT3 raw angle motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#rawDriveName" class="member-name-link">rawDriveName</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">NT3 Raw drive motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#rawDriveVelName" class="member-name-link">rawDriveVelName</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">NT3 Raw drive motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private <a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#simModule" class="member-name-link">simModule</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Simulated swerve module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private double</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#synchronizeEncoderDeadband" class="member-name-link">synchronizeEncoderDeadband</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Encoder synchronization deadband in degrees.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#synchronizeEncoderEnabled" class="member-name-link">synchronizeEncoderEnabled</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Encoder, Absolute encoder synchronization enabled.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#synchronizeEncoderQueued" class="member-name-link">synchronizeEncoderQueued</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Encoder synchronization queued.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,swervelib.parser.SwerveModuleConfiguration,edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">SwerveModule</a><wbr>(int moduleNumber,
|
|
||||||
<a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a> moduleConfiguration,
|
|
||||||
edu.wpi.first.math.controller.SimpleMotorFeedforward driveFeedforward)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Construct the swerve module and initialize the swerve module motors and absolute encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the <a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoderReadIssue()" class="member-name-link">getAbsoluteEncoderReadIssue</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get if the last Absolute Encoder had a read issue, such as it does not exist.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAngleMotor()" class="member-name-link">getAngleMotor</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the angle <a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAnglePIDF()" class="member-name-link">getAnglePIDF</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the current angle/azimuth/steering motor PIDF values.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Fetch the <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed configurations.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCosineCompensatedVelocity(edu.wpi.first.math.kinematics.SwerveModuleState)" class="member-name-link">getCosineCompensatedVelocity</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState desiredState)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the cosine compensated velocity to set the swerve module to.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDriveMotor()" class="member-name-link">getDriveMotor</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the drive <a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDrivePIDF()" class="member-name-link">getDrivePIDF</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the current drive motor PIDF values.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModulePosition</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPosition()" class="member-name-link">getPosition</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the position of the swerve module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRawAbsolutePosition()" class="member-name-link">getRawAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRelativePosition()" class="member-name-link">getRelativePosition</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the relative angle in degrees.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.math.kinematics.SwerveModuleState</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the Swerve Module state.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#pushOffsetsToEncoders()" class="member-name-link">pushOffsetsToEncoders</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Push absolute encoder offset in the memory of the encoder or controller.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#queueSynchronizeEncoders()" class="member-name-link">queueSynchronizeEncoders</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Queue synchronization of the integrated angle encoder with the absolute encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#restoreInternalOffset()" class="member-name-link">restoreInternalOffset</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Restore internal offset in YAGSL and either sets absolute encoder offset to 0 or restores old value.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngle(double)" class="member-name-link">setAngle</a><wbr>(double angle)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the angle for the module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorConversionFactor(double)" class="member-name-link">setAngleMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAngleMotorVoltageCompensation(double)" class="member-name-link">setAngleMotorVoltageCompensation</a><wbr>(double optimalVoltage)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAnglePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">setAnglePIDF</a><wbr>(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> config)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the angle/azimuth/steering motor PID</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAntiJitter(boolean)" class="member-name-link">setAntiJitter</a><wbr>(boolean antiJitter)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the antiJitter functionality, if true the modules will NOT auto center.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDesiredState(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)" class="member-name-link">setDesiredState</a><wbr>(edu.wpi.first.math.kinematics.SwerveModuleState desiredState,
|
|
||||||
boolean isOpenLoop,
|
|
||||||
boolean force)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the desired state of the swerve module.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorConversionFactor(double)" class="member-name-link">setDriveMotorConversionFactor</a><wbr>(double conversionFactor)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the conversion factor for the drive motor controller.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDriveMotorVoltageCompensation(double)" class="member-name-link">setDriveMotorVoltageCompensation</a><wbr>(double optimalVoltage)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDrivePIDF(swervelib.parser.PIDFConfig)" class="member-name-link">setDrivePIDF</a><wbr>(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> config)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the drive PIDF values.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEncoderAutoSynchronize(boolean)" class="member-name-link">setEncoderAutoSynchronize</a><wbr>(boolean enabled)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEncoderAutoSynchronize(boolean,double)" class="member-name-link">setEncoderAutoSynchronize</a><wbr>(boolean enabled,
|
|
||||||
double deadband)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)" class="member-name-link">setFeedforward</a><wbr>(edu.wpi.first.math.controller.SimpleMotorFeedforward drive)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the feedforward attributes to the given parameters.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMotorBrake(boolean)" class="member-name-link">setMotorBrake</a><wbr>(boolean brake)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Set the brake mode.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateTelemetry()" class="member-name-link">updateTelemetry</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Update data sent to <code>SmartDashboard</code>.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configuration">
|
|
||||||
<h3>configuration</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></span> <span class="element-name">configuration</span></div>
|
|
||||||
<div class="block">Swerve module configuration options.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="absolutePositionCache">
|
|
||||||
<h3>absolutePositionCache</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">absolutePositionCache</span></div>
|
|
||||||
<div class="block">Absolute encoder position cache.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="drivePositionCache">
|
|
||||||
<h3>drivePositionCache</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">drivePositionCache</span></div>
|
|
||||||
<div class="block">Drive motor position cache.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="driveVelocityCache">
|
|
||||||
<h3>driveVelocityCache</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="parser/Cache.html" title="class in swervelib.parser">Cache</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Double.html" title="class or interface in java.lang" class="external-link">Double</a>></span> <span class="element-name">driveVelocityCache</span></div>
|
|
||||||
<div class="block">Drive motor velocity cache.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="moduleNumber">
|
|
||||||
<h3>moduleNumber</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">moduleNumber</span></div>
|
|
||||||
<div class="block">Module number for kinematics, usually 0 to 3. front left -> front right -> back left -> back right.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="angleMotor">
|
|
||||||
<h3>angleMotor</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">angleMotor</span></div>
|
|
||||||
<div class="block">Swerve Motors.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="driveMotor">
|
|
||||||
<h3>driveMotor</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">driveMotor</span></div>
|
|
||||||
<div class="block">Swerve Motors.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="absoluteEncoder">
|
|
||||||
<h3>absoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span> <span class="element-name">absoluteEncoder</span></div>
|
|
||||||
<div class="block">Absolute encoder for swerve drive.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoderOffsetWarning">
|
|
||||||
<h3>encoderOffsetWarning</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">encoderOffsetWarning</span></div>
|
|
||||||
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if pushing the Absolute Encoder offset to the encoder fails.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="noEncoderWarning">
|
|
||||||
<h3>noEncoderWarning</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">noEncoderWarning</span></div>
|
|
||||||
<div class="block">An <a href="telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is no Absolute Encoder on the module.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="rawAbsoluteAngleName">
|
|
||||||
<h3>rawAbsoluteAngleName</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">rawAbsoluteAngleName</span></div>
|
|
||||||
<div class="block">NT3 Raw Absolute Angle publisher for the absolute encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="adjAbsoluteAngleName">
|
|
||||||
<h3>adjAbsoluteAngleName</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">adjAbsoluteAngleName</span></div>
|
|
||||||
<div class="block">NT3 Adjusted Absolute angle publisher for the absolute encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="absoluteEncoderIssueName">
|
|
||||||
<h3>absoluteEncoderIssueName</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">absoluteEncoderIssueName</span></div>
|
|
||||||
<div class="block">NT3 Absolute encoder read issue.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="rawAngleName">
|
|
||||||
<h3>rawAngleName</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">rawAngleName</span></div>
|
|
||||||
<div class="block">NT3 raw angle motor.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="rawDriveName">
|
|
||||||
<h3>rawDriveName</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">rawDriveName</span></div>
|
|
||||||
<div class="block">NT3 Raw drive motor.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="rawDriveVelName">
|
|
||||||
<h3>rawDriveVelName</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">rawDriveVelName</span></div>
|
|
||||||
<div class="block">NT3 Raw drive motor.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="maxSpeed">
|
|
||||||
<h3>maxSpeed</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">maxSpeed</span></div>
|
|
||||||
<div class="block">Maximum speed of the drive motors in meters per second.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="driveMotorFeedforward">
|
|
||||||
<h3>driveMotorFeedforward</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.controller.SimpleMotorFeedforward</span> <span class="element-name">driveMotorFeedforward</span></div>
|
|
||||||
<div class="block">Feedforward for the drive motor during closed loop control.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="antiJitterEnabled">
|
|
||||||
<h3>antiJitterEnabled</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">antiJitterEnabled</span></div>
|
|
||||||
<div class="block">Anti-Jitter AKA auto-centering disabled.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="lastState">
|
|
||||||
<h3>lastState</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModuleState</span> <span class="element-name">lastState</span></div>
|
|
||||||
<div class="block">Last swerve module state applied.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="angleOffset">
|
|
||||||
<h3>angleOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">angleOffset</span></div>
|
|
||||||
<div class="block">Angle offset from the absolute encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="simModule">
|
|
||||||
<h3>simModule</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></span> <span class="element-name">simModule</span></div>
|
|
||||||
<div class="block">Simulated swerve module.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="synchronizeEncoderQueued">
|
|
||||||
<h3>synchronizeEncoderQueued</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">synchronizeEncoderQueued</span></div>
|
|
||||||
<div class="block">Encoder synchronization queued.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="synchronizeEncoderEnabled">
|
|
||||||
<h3>synchronizeEncoderEnabled</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">synchronizeEncoderEnabled</span></div>
|
|
||||||
<div class="block">Encoder, Absolute encoder synchronization enabled.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="synchronizeEncoderDeadband">
|
|
||||||
<h3>synchronizeEncoderDeadband</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">synchronizeEncoderDeadband</span></div>
|
|
||||||
<div class="block">Encoder synchronization deadband in degrees.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int,swervelib.parser.SwerveModuleConfiguration,edu.wpi.first.math.controller.SimpleMotorFeedforward)">
|
|
||||||
<h3>SwerveModule</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveModule</span><wbr><span class="parameters">(int moduleNumber,
|
|
||||||
<a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a> moduleConfiguration,
|
|
||||||
edu.wpi.first.math.controller.SimpleMotorFeedforward driveFeedforward)</span></div>
|
|
||||||
<div class="block">Construct the swerve module and initialize the swerve module motors and absolute encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>moduleNumber</code> - Module number for kinematics.</dd>
|
|
||||||
<dd><code>moduleConfiguration</code> - Module constants containing CAN ID's and offsets.</dd>
|
|
||||||
<dd><code>driveFeedforward</code> - Drive motor feedforward created by
|
|
||||||
<a href="math/SwerveMath.html#createDriveFeedforward(double,double,double)"><code>SwerveMath.createDriveFeedforward(double, double, double)</code></a>.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAngleMotorVoltageCompensation(double)">
|
|
||||||
<h3>setAngleMotorVoltageCompensation</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAngleMotorVoltageCompensation</span><wbr><span class="parameters">(double optimalVoltage)</span></div>
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>optimalVoltage</code> - Nominal voltage for operation to output to.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setDriveMotorVoltageCompensation(double)">
|
|
||||||
<h3>setDriveMotorVoltageCompensation</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDriveMotorVoltageCompensation</span><wbr><span class="parameters">(double optimalVoltage)</span></div>
|
|
||||||
<div class="block">Set the voltage compensation for the swerve module motor.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>optimalVoltage</code> - Nominal voltage for operation to output to.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="queueSynchronizeEncoders()">
|
|
||||||
<h3>queueSynchronizeEncoders</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">queueSynchronizeEncoders</span>()</div>
|
|
||||||
<div class="block">Queue synchronization of the integrated angle encoder with the absolute encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setEncoderAutoSynchronize(boolean,double)">
|
|
||||||
<h3>setEncoderAutoSynchronize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEncoderAutoSynchronize</span><wbr><span class="parameters">(boolean enabled,
|
|
||||||
double deadband)</span></div>
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match. This will only occur when the modules are not moving for a few seconds.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>enabled</code> - Enable state</dd>
|
|
||||||
<dd><code>deadband</code> - Deadband in degrees, default is 3 degrees.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setEncoderAutoSynchronize(boolean)">
|
|
||||||
<h3>setEncoderAutoSynchronize</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setEncoderAutoSynchronize</span><wbr><span class="parameters">(boolean enabled)</span></div>
|
|
||||||
<div class="block">Enable auto synchronization for encoders during a match. This will only occur when the modules are not moving for a few seconds.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>enabled</code> - Enable state</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAntiJitter(boolean)">
|
|
||||||
<h3>setAntiJitter</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAntiJitter</span><wbr><span class="parameters">(boolean antiJitter)</span></div>
|
|
||||||
<div class="block">Set the antiJitter functionality, if true the modules will NOT auto center. Pushes the offsets to the angle motor
|
|
||||||
controllers as well.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>antiJitter</code> - Anti-Jitter state desired.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setFeedforward(edu.wpi.first.math.controller.SimpleMotorFeedforward)">
|
|
||||||
<h3>setFeedforward</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setFeedforward</span><wbr><span class="parameters">(edu.wpi.first.math.controller.SimpleMotorFeedforward drive)</span></div>
|
|
||||||
<div class="block">Set the feedforward attributes to the given parameters.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>drive</code> - Drive motor feedforward for the module.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getDrivePIDF()">
|
|
||||||
<h3>getDrivePIDF</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span> <span class="element-name">getDrivePIDF</span>()</div>
|
|
||||||
<div class="block">Get the current drive motor PIDF values.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of the drive motor.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setDrivePIDF(swervelib.parser.PIDFConfig)">
|
|
||||||
<h3>setDrivePIDF</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDrivePIDF</span><wbr><span class="parameters">(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> config)</span></div>
|
|
||||||
<div class="block">Set the drive PIDF values.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>config</code> - <a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of that should be set.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAnglePIDF()">
|
|
||||||
<h3>getAnglePIDF</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a></span> <span class="element-name">getAnglePIDF</span>()</div>
|
|
||||||
<div class="block">Get the current angle/azimuth/steering motor PIDF values.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of the angle motor.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAnglePIDF(swervelib.parser.PIDFConfig)">
|
|
||||||
<h3>setAnglePIDF</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAnglePIDF</span><wbr><span class="parameters">(<a href="parser/PIDFConfig.html" title="class in swervelib.parser">PIDFConfig</a> config)</span></div>
|
|
||||||
<div class="block">Set the angle/azimuth/steering motor PID</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>config</code> - <a href="parser/PIDFConfig.html" title="class in swervelib.parser"><code>PIDFConfig</code></a> of that should be set.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setDesiredState(edu.wpi.first.math.kinematics.SwerveModuleState,boolean,boolean)">
|
|
||||||
<h3>setDesiredState</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDesiredState</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState desiredState,
|
|
||||||
boolean isOpenLoop,
|
|
||||||
boolean force)</span></div>
|
|
||||||
<div class="block">Set the desired state of the swerve module. <br/><b>WARNING: If you are not using one of the functions from
|
|
||||||
<a href="SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> you may screw up <a href="SwerveDrive.html#kinematics"><code>SwerveDrive.kinematics</code></a></b></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>desiredState</code> - Desired swerve module state.</dd>
|
|
||||||
<dd><code>isOpenLoop</code> - Whether to use open loop (direct percent) or direct velocity control.</dd>
|
|
||||||
<dd><code>force</code> - Disables optimizations that prevent movement in the angle motor and forces the desired state
|
|
||||||
onto the swerve module.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getCosineCompensatedVelocity(edu.wpi.first.math.kinematics.SwerveModuleState)">
|
|
||||||
<h3>getCosineCompensatedVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">getCosineCompensatedVelocity</span><wbr><span class="parameters">(edu.wpi.first.math.kinematics.SwerveModuleState desiredState)</span></div>
|
|
||||||
<div class="block">Get the cosine compensated velocity to set the swerve module to.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>desiredState</code> - Desired <code>SwerveModuleState</code> to use.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Cosine compensated velocity in meters/second.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAngle(double)">
|
|
||||||
<h3>setAngle</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAngle</span><wbr><span class="parameters">(double angle)</span></div>
|
|
||||||
<div class="block">Set the angle for the module.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>angle</code> - Angle in degrees.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getState()">
|
|
||||||
<h3>getState</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModuleState</span> <span class="element-name">getState</span>()</div>
|
|
||||||
<div class="block">Get the Swerve Module state.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Current SwerveModule state.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getPosition()">
|
|
||||||
<h3>getPosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.math.kinematics.SwerveModulePosition</span> <span class="element-name">getPosition</span>()</div>
|
|
||||||
<div class="block">Get the position of the swerve module.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>SwerveModulePosition</code> of the swerve module.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position. Falls back to relative position on reading failure.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder angle in degrees in the range [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getRawAbsolutePosition()">
|
|
||||||
<h3>getRawAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRawAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position. Falls back to relative position on reading failure.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder angle in degrees in the range [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getRelativePosition()">
|
|
||||||
<h3>getRelativePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getRelativePosition</span>()</div>
|
|
||||||
<div class="block">Get the relative angle in degrees.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Angle in degrees.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setMotorBrake(boolean)">
|
|
||||||
<h3>setMotorBrake</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setMotorBrake</span><wbr><span class="parameters">(boolean brake)</span></div>
|
|
||||||
<div class="block">Set the brake mode.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>brake</code> - Set the brake mode.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAngleMotorConversionFactor(double)">
|
|
||||||
<h3>setAngleMotorConversionFactor</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setAngleMotorConversionFactor</span><wbr><span class="parameters">(double conversionFactor)</span></div>
|
|
||||||
<div class="block">Set the conversion factor for the angle/azimuth motor controller.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>conversionFactor</code> - Angle motor conversion factor for PID, should be generated from
|
|
||||||
<a href="math/SwerveMath.html#calculateDegreesPerSteeringRotation(double,double)"><code>SwerveMath.calculateDegreesPerSteeringRotation(double, double)</code></a> or calculated.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setDriveMotorConversionFactor(double)">
|
|
||||||
<h3>setDriveMotorConversionFactor</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDriveMotorConversionFactor</span><wbr><span class="parameters">(double conversionFactor)</span></div>
|
|
||||||
<div class="block">Set the conversion factor for the drive motor controller.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>conversionFactor</code> - Drive motor conversion factor for PID, should be generated from
|
|
||||||
<a href="math/SwerveMath.html#calculateMetersPerRotation(double,double,double)"><code>SwerveMath.calculateMetersPerRotation(double, double, double)</code></a> or calculated.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAngleMotor()">
|
|
||||||
<h3>getAngleMotor</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">getAngleMotor</span>()</div>
|
|
||||||
<div class="block">Get the angle <a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the angle/steering motor of the module.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getDriveMotor()">
|
|
||||||
<h3>getDriveMotor</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a></span> <span class="element-name">getDriveMotor</span>()</div>
|
|
||||||
<div class="block">Get the drive <a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="motors/SwerveMotor.html" title="class in swervelib.motors"><code>SwerveMotor</code></a> for the drive motor of the module.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the <a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="encoders/SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a> for the swerve module.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getConfiguration()">
|
|
||||||
<h3>getConfiguration</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser">SwerveModuleConfiguration</a></span> <span class="element-name">getConfiguration</span>()</div>
|
|
||||||
<div class="block">Fetch the <a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a> with the parsed configurations.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><a href="parser/SwerveModuleConfiguration.html" title="class in swervelib.parser"><code>SwerveModuleConfiguration</code></a> for the <a href="SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a>.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="pushOffsetsToEncoders()">
|
|
||||||
<h3>pushOffsetsToEncoders</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">pushOffsetsToEncoders</span>()</div>
|
|
||||||
<div class="block">Push absolute encoder offset in the memory of the encoder or controller. Also removes the internal angle offset.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="restoreInternalOffset()">
|
|
||||||
<h3>restoreInternalOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">restoreInternalOffset</span>()</div>
|
|
||||||
<div class="block">Restore internal offset in YAGSL and either sets absolute encoder offset to 0 or restores old value.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoderReadIssue()">
|
|
||||||
<h3>getAbsoluteEncoderReadIssue</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">getAbsoluteEncoderReadIssue</span>()</div>
|
|
||||||
<div class="block">Get if the last Absolute Encoder had a read issue, such as it does not exist.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>If the last Absolute Encoder had a read issue, or absolute encoder does not exist.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="updateTelemetry()">
|
|
||||||
<h3>updateTelemetry</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateTelemetry</span>()</div>
|
|
||||||
<div class="block">Update data sent to <code>SmartDashboard</code>.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,369 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>AnalogAbsoluteEncoderSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: AnalogAbsoluteEncoderSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class AnalogAbsoluteEncoderSwerve" class="title">Class AnalogAbsoluteEncoderSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.AnalogAbsoluteEncoderSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">AnalogAbsoluteEncoderSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#cannotSetOffset" class="member-name-link">cannotSetOffset</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>edu.wpi.first.wpilibj.AnalogInput</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Encoder as Analog Input.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> detailing how the analog absolute encoder may not report accurate velocities.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#inverted" class="member-name-link">inverted</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Inversion state of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">AnalogAbsoluteEncoderSwerve</a><wbr>(int channel)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Construct the Encoder given the analog input channel.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(edu.wpi.first.wpilibj.AnalogInput)" class="member-name-link">AnalogAbsoluteEncoderSwerve</a><wbr>(edu.wpi.first.wpilibj.AnalogInput encoder)</code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Construct the Thrifty Encoder as a Swerve Absolute Encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Cannot Set the offset of an Analog Absolute Encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">edu.wpi.first.wpilibj.AnalogInput</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">Encoder as Analog Input.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="inverted">
|
|
||||||
<h3>inverted</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">inverted</span></div>
|
|
||||||
<div class="block">Inversion state of the encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="cannotSetOffset">
|
|
||||||
<h3>cannotSetOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">cannotSetOffset</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="inaccurateVelocities">
|
|
||||||
<h3>inaccurateVelocities</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">inaccurateVelocities</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> detailing how the analog absolute encoder may not report accurate velocities.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(edu.wpi.first.wpilibj.AnalogInput)">
|
|
||||||
<h3>AnalogAbsoluteEncoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AnalogAbsoluteEncoderSwerve</span><wbr><span class="parameters">(edu.wpi.first.wpilibj.AnalogInput encoder)</span></div>
|
|
||||||
<div class="block">Construct the Thrifty Encoder as a Swerve Absolute Encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>encoder</code> - Encoder to construct.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int)">
|
|
||||||
<h3>AnalogAbsoluteEncoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">AnalogAbsoluteEncoderSwerve</span><wbr><span class="parameters">(int channel)</span></div>
|
|
||||||
<div class="block">Construct the Encoder given the analog input channel.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>channel</code> - Analog Input channel of which the encoder resides.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Cannot Set the offset of an Analog Absolute Encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Will always be false as setting the offset is unsupported of an Analog absolute encoder.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,396 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>CANCoderSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: CANCoderSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class CANCoderSwerve" class="title">Class CANCoderSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.CANCoderSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CANCoderSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#cannotSetOffset" class="member-name-link">cannotSetOffset</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>com.ctre.phoenix6.hardware.CANcoder</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">CANCoder with WPILib sendable and support.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#magnetFieldLessThanIdeal" class="member-name-link">magnetFieldLessThanIdeal</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#readingFaulty" class="member-name-link">readingFaulty</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#readingIgnored" class="member-name-link">readingIgnored</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>static double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#STATUS_TIMEOUT_SECONDS" class="member-name-link">STATUS_TIMEOUT_SECONDS</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Wait time for status frames to show up.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">CANCoderSwerve</a><wbr>(int id)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Initialize the CANCoder on the standard CANBus.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,java.lang.String)" class="member-name-link">CANCoderSwerve</a><wbr>(int id,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> canbus)</code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Initialize the CANCoder on the CANivore.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets the Absolute Encoder Offset within the CANcoder's Memory.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="STATUS_TIMEOUT_SECONDS">
|
|
||||||
<h3>STATUS_TIMEOUT_SECONDS</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">double</span> <span class="element-name">STATUS_TIMEOUT_SECONDS</span></div>
|
|
||||||
<div class="block">Wait time for status frames to show up.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.ctre.phoenix6.hardware.CANcoder</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">CANCoder with WPILib sendable and support.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="magnetFieldLessThanIdeal">
|
|
||||||
<h3>magnetFieldLessThanIdeal</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">magnetFieldLessThanIdeal</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder magnet field is less than ideal.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="readingFaulty">
|
|
||||||
<h3>readingFaulty</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">readingFaulty</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="readingIgnored">
|
|
||||||
<h3>readingIgnored</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">readingIgnored</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the CANCoder reading is faulty and the reading is ignored.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="cannotSetOffset">
|
|
||||||
<h3>cannotSetOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">cannotSetOffset</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder offset cannot be set.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int)">
|
|
||||||
<h3>CANCoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CANCoderSwerve</span><wbr><span class="parameters">(int id)</span></div>
|
|
||||||
<div class="block">Initialize the CANCoder on the standard CANBus.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>id</code> - CAN ID.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int,java.lang.String)">
|
|
||||||
<h3>CANCoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CANCoderSwerve</span><wbr><span class="parameters">(int id,
|
|
||||||
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> canbus)</span></div>
|
|
||||||
<div class="block">Initialize the CANCoder on the CANivore.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>id</code> - CAN ID.</dd>
|
|
||||||
<dd><code>canbus</code> - CAN bus to initialize it on.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder. Sets <a href="SwerveAbsoluteEncoder.html#readingError"><code>SwerveAbsoluteEncoder.readingError</code></a> on erroneous readings.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Sets the Absolute Encoder Offset within the CANcoder's Memory.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point in degrees.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>if setting Absolute Encoder Offset was successful or not.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,320 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sat Aug 24 17:37:32 CDT 2024 -->
|
|
||||||
<title>CanAndCoderSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-08-24">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: CanAndCoderSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class CanAndCoderSwerve" class="title">Class CanAndCoderSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.CanAndCoderSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CanAndCoderSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">HELIUM <code>Canandmag</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>com.reduxrobotics.sensors.canandmag.Canandmag</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">The <code>Canandmag</code> representing the CANandCoder on the CAN bus.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">CanAndCoderSwerve</a><wbr>(int canid)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Create the <code>Canandmag</code></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the Canandcoder to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Cannot set the offset of the Canandcoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.reduxrobotics.sensors.canandmag.Canandmag</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">The <code>Canandmag</code> representing the CANandCoder on the CAN bus.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int)">
|
|
||||||
<h3>CanAndCoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CanAndCoderSwerve</span><wbr><span class="parameters">(int canid)</span></div>
|
|
||||||
<div class="block">Create the <code>Canandmag</code></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>canid</code> - The CAN ID whenever the CANandCoder is operating on the CANBus.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.
|
|
||||||
<p>
|
|
||||||
This will not clear the stored zero offset.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the Canandcoder to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Cannot set the offset of the Canandcoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>true if setting the zero point succeeded, false otherwise</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,320 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>CanAndMagSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: CanAndMagSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class CanAndMagSwerve" class="title">Class CanAndMagSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.CanAndMagSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CanAndMagSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">HELIUM <code>Canandmag</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>com.reduxrobotics.sensors.canandmag.Canandmag</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">The <code>Canandmag</code> representing the CANandMag on the CAN bus.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">CanAndMagSwerve</a><wbr>(int canid)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Create the <code>Canandmag</code></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the CANandMag to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Cannot set the offset of the CANandMag.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.reduxrobotics.sensors.canandmag.Canandmag</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">The <code>Canandmag</code> representing the CANandMag on the CAN bus.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int)">
|
|
||||||
<h3>CanAndMagSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CanAndMagSwerve</span><wbr><span class="parameters">(int canid)</span></div>
|
|
||||||
<div class="block">Create the <code>Canandmag</code></div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>canid</code> - The CAN ID whenever the CANandMag is operating on the CANBus.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.
|
|
||||||
<p>
|
|
||||||
This will not clear the stored zero offset.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the CANandMag to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Cannot set the offset of the CANandMag.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>true if setting the zero point succeeded, false otherwise</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,360 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>PWMDutyCycleEncoderSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: PWMDutyCycleEncoderSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class PWMDutyCycleEncoderSwerve" class="title">Class PWMDutyCycleEncoderSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.PWMDutyCycleEncoderSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PWMDutyCycleEncoderSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
|
|
||||||
Encoder." attached via a PWM lane.
|
|
||||||
<p>
|
|
||||||
Credits to
|
|
||||||
<a href="https://github.com/p2reneker25/2035-YAGSL/blob/main/swervelib/encoders/PWMDutyCycleEncoderSwerve.java">
|
|
||||||
p2reneker25</a> for building this.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>private final edu.wpi.first.wpilibj.DutyCycleEncoder</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Duty Cycle Encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#inaccurateVelocities" class="member-name-link">inaccurateVelocities</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the encoder cannot report accurate velocities.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private boolean</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#isInverted" class="member-name-link">isInverted</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Inversion state.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private double</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#offset" class="member-name-link">offset</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">The Offset in degrees of the PWM absolute encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">PWMDutyCycleEncoderSwerve</a><wbr>(int pin)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Constructor for the PWM duty cycle encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the inversion state of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the encoder object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">edu.wpi.first.wpilibj.DutyCycleEncoder</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">Duty Cycle Encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="isInverted">
|
|
||||||
<h3>isInverted</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name">isInverted</span></div>
|
|
||||||
<div class="block">Inversion state.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="inaccurateVelocities">
|
|
||||||
<h3>inaccurateVelocities</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">inaccurateVelocities</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the encoder cannot report accurate velocities.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="offset">
|
|
||||||
<h3>offset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">double</span> <span class="element-name">offset</span></div>
|
|
||||||
<div class="block">The Offset in degrees of the PWM absolute encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(int)">
|
|
||||||
<h3>PWMDutyCycleEncoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PWMDutyCycleEncoderSwerve</span><wbr><span class="parameters">(int pin)</span></div>
|
|
||||||
<div class="block">Constructor for the PWM duty cycle encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>pin</code> - PWM lane for the encoder.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the inversion state of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the encoder object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd><code>DutyCycleEncoder</code> from the class.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">SwerveAbsoluteEncoder</a></code></span></div>
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point in degrees.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>if setting Absolute Encoder Offset was successful or not.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,363 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>SparkMaxAnalogEncoderSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxAnalogEncoderSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class SparkMaxAnalogEncoderSwerve" class="title">Class SparkMaxAnalogEncoderSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.SparkMaxAnalogEncoderSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SparkMaxAnalogEncoderSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#doesNotSupportIntegratedOffsets" class="member-name-link">doesNotSupportIntegratedOffsets</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder does not support integrated offsets.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>com.revrobotics.SparkAnalogSensor</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">The <code>SparkAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#failureConfiguring" class="member-name-link">failureConfiguring</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,double)" class="member-name-link">SparkMaxAnalogEncoderSwerve</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> motor,
|
|
||||||
double maxVoltage)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Create the <a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data
|
|
||||||
port analog pin.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><com.revrobotics.REVLibError> config)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.revrobotics.SparkAnalogSensor</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">The <code>SparkAnalogSensor</code> representing the duty cycle encoder attached to the SparkMax analog port.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="failureConfiguring">
|
|
||||||
<h3>failureConfiguring</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">failureConfiguring</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="doesNotSupportIntegratedOffsets">
|
|
||||||
<h3>doesNotSupportIntegratedOffsets</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">doesNotSupportIntegratedOffsets</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if the absolute encoder does not support integrated offsets.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(swervelib.motors.SwerveMotor,double)">
|
|
||||||
<h3>SparkMaxAnalogEncoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SparkMaxAnalogEncoderSwerve</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> motor,
|
|
||||||
double maxVoltage)</span></div>
|
|
||||||
<div class="block">Create the <a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxAnalogEncoderSwerve</code></a> object as a analog sensor from the <code>CANSparkMax</code> motor data
|
|
||||||
port analog pin.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>motor</code> - Motor to create the encoder from.</dd>
|
|
||||||
<dd><code>maxVoltage</code> - Maximum voltage for analog input reading.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configureSparkMax(java.util.function.Supplier)">
|
|
||||||
<h3>configureSparkMax</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">configureSparkMax</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><com.revrobotics.REVLibError> config)</span></div>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>if setting Absolute Encoder Offset was successful or not.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,361 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>SparkMaxEncoderSwerve</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: SparkMaxEncoderSwerve">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class SparkMaxEncoderSwerve" class="title">Class SparkMaxEncoderSwerve</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">swervelib.encoders.SwerveAbsoluteEncoder</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.SparkMaxEncoderSwerve</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SparkMaxEncoderSwerve</span>
|
|
||||||
<span class="extends-implements">extends <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></span></div>
|
|
||||||
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>com.revrobotics.AbsoluteEncoder</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#encoder" class="member-name-link">encoder</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#failureConfiguring" class="member-name-link">failureConfiguring</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color"><code>private <a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#offsetFailure" class="member-name-link">offsetFailure</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder offset.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="fields-inherited-from-class-swervelib.encoders.SwerveAbsoluteEncoder">Fields inherited from class swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></h3>
|
|
||||||
<code><a href="SwerveAbsoluteEncoder.html#maximumRetries">maximumRetries</a>, <a href="SwerveAbsoluteEncoder.html#readingError">readingError</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(swervelib.motors.SwerveMotor,int)" class="member-name-link">SparkMaxEncoderSwerve</a><wbr>(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> motor,
|
|
||||||
int conversionFactor)</code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Create the <a href="SparkMaxEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxEncoderSwerve</code></a> object as a duty cycle from the <code>CANSparkMax</code> motor.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#configureSparkMax(java.util.function.Supplier)" class="member-name-link">configureSparkMax</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><com.revrobotics.REVLibError> config)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
||||||
<div class="block">Sets the Absolute Encoder Offset inside of the SparkMax's Memory.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="encoder">
|
|
||||||
<h3>encoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.revrobotics.AbsoluteEncoder</span> <span class="element-name">encoder</span></div>
|
|
||||||
<div class="block">The <code>AbsoluteEncoder</code> representing the duty cycle encoder attached to the SparkMax.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="failureConfiguring">
|
|
||||||
<h3>failureConfiguring</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">failureConfiguring</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="offsetFailure">
|
|
||||||
<h3>offsetFailure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../telemetry/Alert.html" title="class in swervelib.telemetry">Alert</a></span> <span class="element-name">offsetFailure</span></div>
|
|
||||||
<div class="block">An <a href="../telemetry/Alert.html" title="class in swervelib.telemetry"><code>Alert</code></a> for if there is a failure configuring the encoder offset.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>(swervelib.motors.SwerveMotor,int)">
|
|
||||||
<h3>SparkMaxEncoderSwerve</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SparkMaxEncoderSwerve</span><wbr><span class="parameters">(<a href="../motors/SwerveMotor.html" title="class in swervelib.motors">SwerveMotor</a> motor,
|
|
||||||
int conversionFactor)</span></div>
|
|
||||||
<div class="block">Create the <a href="SparkMaxEncoderSwerve.html" title="class in swervelib.encoders"><code>SparkMaxEncoderSwerve</code></a> object as a duty cycle from the <code>CANSparkMax</code> motor.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>motor</code> - Motor to create the encoder from.</dd>
|
|
||||||
<dd><code>conversionFactor</code> - The conversion factor to set if the output is not from 0 to 360.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configureSparkMax(java.util.function.Supplier)">
|
|
||||||
<h3>configureSparkMax</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name">configureSparkMax</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Supplier.html" title="class or interface in java.util.function" class="external-link">Supplier</a><com.revrobotics.REVLibError> config)</span></div>
|
|
||||||
<div class="block">Run the configuration until it succeeds or times out.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>config</code> - Lambda supplier returning the error state.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#factoryDefault()">factoryDefault</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#clearStickyFaults()">clearStickyFaults</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#configure(boolean)">configure</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsolutePosition()">getAbsolutePosition</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getAbsoluteEncoder()">getAbsoluteEncoder</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Sets the Absolute Encoder Offset inside of the SparkMax's Memory.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#setAbsoluteEncoderOffset(double)">setAbsoluteEncoderOffset</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>if setting Absolute Encoder Offset was successful or not.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Specified by:</dt>
|
|
||||||
<dd><code><a href="SwerveAbsoluteEncoder.html#getVelocity()">getVelocity</a></code> in class <code><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></code></dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,312 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>SwerveAbsoluteEncoder</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders, class: SwerveAbsoluteEncoder">
|
|
||||||
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="class-declaration-page">
|
|
||||||
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
||||||
var oddRowColor = "odd-row-color";
|
|
||||||
var tableTab = "table-tab";
|
|
||||||
var activeTableTab = "active-table-tab";
|
|
||||||
var pathtoroot = "../../";
|
|
||||||
loadScripts(document, 'script');</script>
|
|
||||||
<noscript>
|
|
||||||
<div>JavaScript is disabled on your browser.</div>
|
|
||||||
</noscript>
|
|
||||||
<div class="flex-box">
|
|
||||||
<header role="banner" class="flex-header">
|
|
||||||
<nav role="navigation">
|
|
||||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
||||||
<div class="top-nav" id="navbar-top">
|
|
||||||
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
||||||
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
||||||
<li><a href="../../index.html">Overview</a></li>
|
|
||||||
<li><a href="package-summary.html">Package</a></li>
|
|
||||||
<li class="nav-bar-cell1-rev">Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#class">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Summary: </li>
|
|
||||||
<li>Nested | </li>
|
|
||||||
<li><a href="#field-summary">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
||||||
<li><a href="#method-summary">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Detail: </li>
|
|
||||||
<li><a href="#field-detail">Field</a> | </li>
|
|
||||||
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
||||||
<li><a href="#method-detail">Method</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<!-- ======== START OF CLASS DATA ======== -->
|
|
||||||
<div class="header">
|
|
||||||
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">swervelib.encoders</a></div>
|
|
||||||
<h1 title="Class SwerveAbsoluteEncoder" class="title">Class SwerveAbsoluteEncoder</h1>
|
|
||||||
</div>
|
|
||||||
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
||||||
<div class="inheritance">swervelib.encoders.SwerveAbsoluteEncoder</div>
|
|
||||||
</div>
|
|
||||||
<section class="class-description" id="class-description">
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Direct Known Subclasses:</dt>
|
|
||||||
<dd><code><a href="AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></code>, <code><a href="CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></code>, <code><a href="CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></code>, <code><a href="PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></code>, <code><a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></code>, <code><a href="SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></code></dd>
|
|
||||||
</dl>
|
|
||||||
<hr>
|
|
||||||
<div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">SwerveAbsoluteEncoder</span>
|
|
||||||
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
||||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<!-- =========== FIELD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-summary" id="field-summary">
|
|
||||||
<h2>Field Summary</h2>
|
|
||||||
<div class="caption"><span>Fields</span></div>
|
|
||||||
<div class="summary-table three-column-summary">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Field</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><code>final int</code></div>
|
|
||||||
<div class="col-second even-row-color"><code><a href="#maximumRetries" class="member-name-link">maximumRetries</a></code></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">The maximum amount of times the swerve encoder will attempt to configure itself if failures occur.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color"><code>boolean</code></div>
|
|
||||||
<div class="col-second odd-row-color"><code><a href="#readingError" class="member-name-link">readingError</a></code></div>
|
|
||||||
<div class="col-last odd-row-color">
|
|
||||||
<div class="block">Last angle reading was faulty.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-summary" id="constructor-summary">
|
|
||||||
<h2>Constructor Summary</h2>
|
|
||||||
<div class="caption"><span>Constructors</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Constructor</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">SwerveAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color"> </div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========== METHOD SUMMARY =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-summary" id="method-summary">
|
|
||||||
<h2>Method Summary</h2>
|
|
||||||
<div id="method-summary-table">
|
|
||||||
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div>
|
|
||||||
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
||||||
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
||||||
<div class="table-header col-first">Modifier and Type</div>
|
|
||||||
<div class="table-header col-second">Method</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#clearStickyFaults()" class="member-name-link">clearStickyFaults</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#configure(boolean)" class="member-name-link">configure</a><wbr>(boolean inverted)</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract void</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#factoryDefault()" class="member-name-link">factoryDefault</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAbsoluteEncoder()" class="member-name-link">getAbsoluteEncoder</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract double</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAbsolutePosition()" class="member-name-link">getAbsolutePosition</a>()</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract double</code></div>
|
|
||||||
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVelocity()" class="member-name-link">getVelocity</a>()</code></div>
|
|
||||||
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract boolean</code></div>
|
|
||||||
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setAbsoluteEncoderOffset(double)" class="member-name-link">setAbsoluteEncoderOffset</a><wbr>(double offset)</code></div>
|
|
||||||
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="inherited-list">
|
|
||||||
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
||||||
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section class="details">
|
|
||||||
<ul class="details-list">
|
|
||||||
<!-- ============ FIELD DETAIL =========== -->
|
|
||||||
<li>
|
|
||||||
<section class="field-details" id="field-detail">
|
|
||||||
<h2>Field Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="maximumRetries">
|
|
||||||
<h3>maximumRetries</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">int</span> <span class="element-name">maximumRetries</span></div>
|
|
||||||
<div class="block">The maximum amount of times the swerve encoder will attempt to configure itself if failures occur.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>See Also:</dt>
|
|
||||||
<dd>
|
|
||||||
<ul class="see-list">
|
|
||||||
<li><a href="../../constant-values.html#swervelib.encoders.SwerveAbsoluteEncoder.maximumRetries">Constant Field Values</a></li>
|
|
||||||
</ul>
|
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="readingError">
|
|
||||||
<h3>readingError</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">readingError</span></div>
|
|
||||||
<div class="block">Last angle reading was faulty.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
||||||
<li>
|
|
||||||
<section class="constructor-details" id="constructor-detail">
|
|
||||||
<h2>Constructor Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="<init>()">
|
|
||||||
<h3>SwerveAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SwerveAbsoluteEncoder</span>()</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<!-- ============ METHOD DETAIL ========== -->
|
|
||||||
<li>
|
|
||||||
<section class="method-details" id="method-detail">
|
|
||||||
<h2>Method Details</h2>
|
|
||||||
<ul class="member-list">
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="factoryDefault()">
|
|
||||||
<h3>factoryDefault</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">factoryDefault</span>()</div>
|
|
||||||
<div class="block">Reset the encoder to factory defaults.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="clearStickyFaults()">
|
|
||||||
<h3>clearStickyFaults</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">clearStickyFaults</span>()</div>
|
|
||||||
<div class="block">Clear sticky faults on the encoder.</div>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="configure(boolean)">
|
|
||||||
<h3>configure</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name">configure</span><wbr><span class="parameters">(boolean inverted)</span></div>
|
|
||||||
<div class="block">Configure the absolute encoder to read from [0, 360) per second.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>inverted</code> - Whether the encoder is inverted.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsolutePosition()">
|
|
||||||
<h3>getAbsolutePosition</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">double</span> <span class="element-name">getAbsolutePosition</span>()</div>
|
|
||||||
<div class="block">Get the absolute position of the encoder.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute position in degrees from [0, 360).</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getAbsoluteEncoder()">
|
|
||||||
<h3>getAbsoluteEncoder</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span> <span class="element-name">getAbsoluteEncoder</span>()</div>
|
|
||||||
<div class="block">Get the instantiated absolute encoder Object.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>Absolute encoder object.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="setAbsoluteEncoderOffset(double)">
|
|
||||||
<h3>setAbsoluteEncoderOffset</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">setAbsoluteEncoderOffset</span><wbr><span class="parameters">(double offset)</span></div>
|
|
||||||
<div class="block">Sets the Absolute Encoder offset at the Encoder Level.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Parameters:</dt>
|
|
||||||
<dd><code>offset</code> - the offset the Absolute Encoder uses as the zero point in degrees.</dd>
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>if setting Absolute Encoder Offset was successful or not.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<section class="detail" id="getVelocity()">
|
|
||||||
<h3>getVelocity</h3>
|
|
||||||
<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">double</span> <span class="element-name">getVelocity</span>()</div>
|
|
||||||
<div class="block">Get the velocity in degrees/sec.</div>
|
|
||||||
<dl class="notes">
|
|
||||||
<dt>Returns:</dt>
|
|
||||||
<dd>velocity in degrees/sec.</dd>
|
|
||||||
</dl>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<!-- ========= END OF CLASS DATA ========= -->
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,125 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>swervelib.encoders</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="declaration: package: swervelib.encoders">
|
|
||||||
<meta name="generator" content="javadoc/PackageWriterImpl">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-declaration-page">
|
|
||||||
<script type="text/javascript">var pathtoroot = "../../";
|
|
||||||
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 class="nav-bar-cell1-rev">Package</li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li><a href="package-tree.html">Tree</a></li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#package">Help</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="sub-nav">
|
|
||||||
<div>
|
|
||||||
<ul class="sub-nav-list">
|
|
||||||
<li>Package: </li>
|
|
||||||
<li><a href="#package-description">Description</a> | </li>
|
|
||||||
<li><a href="#related-package-summary">Related Packages</a> | </li>
|
|
||||||
<li><a href="#class-summary">Classes and Interfaces</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
||||||
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
||||||
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
||||||
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
||||||
</header>
|
|
||||||
<div class="flex-content">
|
|
||||||
<main role="main">
|
|
||||||
<div class="header">
|
|
||||||
<h1 title="Package swervelib.encoders" class="title">Package swervelib.encoders</h1>
|
|
||||||
</div>
|
|
||||||
<hr>
|
|
||||||
<div class="package-signature">package <span class="element-name">swervelib.encoders</span></div>
|
|
||||||
<section class="package-description" id="package-description">
|
|
||||||
<div class="block">Absolute encoders for the swerve drive, all implement <a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders"><code>SwerveAbsoluteEncoder</code></a>.</div>
|
|
||||||
</section>
|
|
||||||
<section class="summary">
|
|
||||||
<ul class="summary-list">
|
|
||||||
<li>
|
|
||||||
<div id="related-package-summary">
|
|
||||||
<div class="caption"><span>Related Packages</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Package</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color"><a href="../package-summary.html">swervelib</a></div>
|
|
||||||
<div class="col-last even-row-color">
|
|
||||||
<div class="block">Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<div id="class-summary">
|
|
||||||
<div class="caption"><span>Classes</span></div>
|
|
||||||
<div class="summary-table two-column-summary">
|
|
||||||
<div class="table-header col-first">Class</div>
|
|
||||||
<div class="table-header col-last">Description</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="AnalogAbsoluteEncoderSwerve.html" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="CanAndMagSwerve.html" title="class in swervelib.encoders">CanAndMagSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">HELIUM <code>Canandmag</code> from ReduxRobotics absolute encoder, attached through the CAN bus.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="CANCoderSwerve.html" title="class in swervelib.encoders">CANCoderSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">Swerve Absolute Encoder for CTRE CANCoders.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="PWMDutyCycleEncoderSwerve.html" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">DutyCycle encoders such as "US Digital MA3 with PWM Output, the CTRE Mag Encoder, the Rev Hex Encoder, and the AM Mag
|
|
||||||
Encoder." attached via a PWM lane.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SparkMaxAnalogEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">SparkMax absolute encoder, attached through the data port analog pin.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SparkMaxEncoderSwerve.html" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></div>
|
|
||||||
<div class="col-last odd-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">SparkMax absolute encoder, attached through the data port.</div>
|
|
||||||
</div>
|
|
||||||
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SwerveAbsoluteEncoder.html" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a></div>
|
|
||||||
<div class="col-last even-row-color class-summary class-summary-tab2">
|
|
||||||
<div class="block">Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
<!DOCTYPE HTML>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<!-- Generated by javadoc (17) on Sun Oct 20 09:12:47 CDT 2024 -->
|
|
||||||
<title>swervelib.encoders Class Hierarchy</title>
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
||||||
<meta name="dc.created" content="2024-10-20">
|
|
||||||
<meta name="description" content="tree: package: swervelib.encoders">
|
|
||||||
<meta name="generator" content="javadoc/PackageTreeWriter">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../script-dir/jquery-ui.min.css" title="Style">
|
|
||||||
<link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style">
|
|
||||||
<script type="text/javascript" src="../../script.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-3.5.1.min.js"></script>
|
|
||||||
<script type="text/javascript" src="../../script-dir/jquery-ui.min.js"></script>
|
|
||||||
</head>
|
|
||||||
<body class="package-tree-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><a href="package-summary.html">Package</a></li>
|
|
||||||
<li>Class</li>
|
|
||||||
<li class="nav-bar-cell1-rev">Tree</li>
|
|
||||||
<li><a href="../../index-files/index-1.html">Index</a></li>
|
|
||||||
<li><a href="../../help-doc.html#tree">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 class="title">Hierarchy For Package swervelib.encoders</h1>
|
|
||||||
<span class="package-hierarchy-label">Package Hierarchies:</span>
|
|
||||||
<ul class="horizontal">
|
|
||||||
<li><a href="../../overview-tree.html">All Packages</a></li>
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
<section class="hierarchy">
|
|
||||||
<h2 title="Class Hierarchy">Class Hierarchy</h2>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" class="type-name-link external-link" title="class or interface in java.lang">Object</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="SwerveAbsoluteEncoder.html" class="type-name-link" title="class in swervelib.encoders">SwerveAbsoluteEncoder</a>
|
|
||||||
<ul>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="AnalogAbsoluteEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">AnalogAbsoluteEncoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="CanAndMagSwerve.html" class="type-name-link" title="class in swervelib.encoders">CanAndMagSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="CANCoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">CANCoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="PWMDutyCycleEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">PWMDutyCycleEncoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="SparkMaxAnalogEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxAnalogEncoderSwerve</a></li>
|
|
||||||
<li class="circle">swervelib.encoders.<a href="SparkMaxEncoderSwerve.html" class="type-name-link" title="class in swervelib.encoders">SparkMaxEncoderSwerve</a></li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||