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

Updated docs, renamed SwerveDrive lock function and setBrake function

Browse Source
This commit is contained in:
thenetworkgrinch
2023-02-15 22:18:27 -06:00
parent e4436b5ed2
commit e8f6ca3659
111 changed files with 3086 additions and 384 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
docs/index-files/index-17.html
View File

@@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Wed Feb 15 00:08:08 CST 2023 -->
<!-- Generated by javadoc (17) on Wed Feb 15 22:17:49 CST 2023 -->
<title>S-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -85,6 +85,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the absolute encoder to be a compatible absolute encoder.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#setAngle(double)" class="member-name-link">setAngle(double)</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Set the heading of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#setAngle(double)" class="member-name-link">setAngle(double)</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Set the angle for the module.</div>
@@ -117,10 +121,6 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the desired state of the swerve module.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#setDriveBrake()" class="member-name-link">setDriveBrake()</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/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>
@@ -229,6 +229,22 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the voltage compensation for the swerve module motor.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#setYaw(double)" class="member-name-link">setYaw(double)</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 yaw in degrees.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#setYaw(double)" class="member-name-link">setYaw(double)</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 yaw in degrees.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#setYaw(double)" class="member-name-link">setYaw(double)</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 yaw in degrees.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#setYaw(double)" class="member-name-link">setYaw(double)</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 yaw in degrees.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#setYaw(double)" class="member-name-link">setYaw(double)</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 yaw in degrees.</div>
@@ -245,6 +261,14 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Set the yaw in degrees.</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/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>
@@ -275,14 +299,14 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">REV Slots for PID configuration.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#speed" class="member-name-link">speed</a> - Variable in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Current state.</div>
</dd>
<dt><a href="../swervelib/math/SwerveModuleState2.html#speedMetersPerSecond" class="member-name-link">speedMetersPerSecond</a> - Variable in class swervelib.math.<a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math">SwerveModuleState2</a></dt>
<dd>
<div class="block">Swerve module speed in meters per second.</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/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>
@@ -354,6 +378,14 @@ loadScripts(document, 'script');</script>
</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>&nbsp;</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveIMUSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
<dd>
<div class="block">Simulation for <a href="../swervelib/SwerveDrive.html" title="class in swervelib"><code>SwerveDrive</code></a> IMU.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveIMUSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Create the swerve drive IMU simulation.</div>
</dd>
<dt><a href="../swervelib/math/SwerveKinematics2.html" class="type-name-link" title="class in swervelib.math">SwerveKinematics2</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
<dd>
<div class="block">Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis
@@ -381,6 +413,8 @@ loadScripts(document, 'script');</script>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/parser/json/modules/package-summary.html">swervelib.parser.json.modules</a> - package swervelib.parser.json.modules</dt>
<dd>&nbsp;</dd>
<dt><a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a> - package swervelib.simulation</dt>
<dd>&nbsp;</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>
@@ -423,6 +457,14 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Swerve modules.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html" class="type-name-link" title="class in swervelib.simulation">SwerveModuleSimulation</a> - Class in <a href="../swervelib/simulation/package-summary.html">swervelib.simulation</a></dt>
<dd>
<div class="block">Class to hold simulation data for <a href="../swervelib/SwerveModule.html" title="class in swervelib"><code>SwerveModule</code></a></div>
</dd>
<dt><a href="../swervelib/simulation/SwerveModuleSimulation.html#%3Cinit%3E()" class="member-name-link">SwerveModuleSimulation()</a> - Constructor for class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Create simulation class and initialize module at 0.</div>
</dd>
<dt><a href="../swervelib/math/SwerveModuleState2.html" class="type-name-link" title="class in swervelib.math">SwerveModuleState2</a> - Class in <a href="../swervelib/math/package-summary.html">swervelib.math</a></dt>
<dd>
<div class="block">Second order kinematics swerve module state.</div>