Updated docs, renamed SwerveDrive lock function and setBrake function

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

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>G-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@@ -89,9 +89,29 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Gets the current field-relative velocity (x, y and omega) of the robot</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getGyroRotation3d()" class="member-name-link">getGyroRotation3d()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Gets the estimated gyro <code>Rotation3d</code> of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getGyroRotation3d()" class="member-name-link">getGyroRotation3d()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current gyro Rotation3d of the robot, as reported by the imu.</div>
<div class="block">Gets the current gyro <code>Rotation3d</code> of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16448Swerve.html" title="class in swervelib.imu">ADIS16448Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADIS16470Swerve.html" title="class in swervelib.imu">ADIS16470Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/ADXRS450Swerve.html" title="class in swervelib.imu">ADXRS450Swerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Get the instantiated IMU object.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#getIMU()" class="member-name-link">getIMU()</a> - Method in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
@@ -133,6 +153,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Get the motor object from the module.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getPitch()" class="member-name-link">getPitch()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Pitch is not simulated currently, always returns 0.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getPitch()" class="member-name-link">getPitch()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current pitch angle of the robot, as reported by the imu.</div>
@@ -157,6 +181,10 @@ loadScripts(document, 'script');</script>
<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>
@@ -173,10 +201,18 @@ loadScripts(document, 'script');</script>
<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/simulation/SwerveModuleSimulation.html#getState()" class="member-name-link">getState()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveModuleSimulation.html" title="class in swervelib.simulation">SwerveModuleSimulation</a></dt>
<dd>
<div class="block">Get the <a href="../swervelib/math/SwerveModuleState2.html" title="class in swervelib.math"><code>SwerveModuleState2</code></a> of the simulated module.</div>
</dd>
<dt><a href="../swervelib/SwerveModule.html#getState()" class="member-name-link">getState()</a> - Method in class swervelib.<a href="../swervelib/SwerveModule.html" title="class in swervelib">SwerveModule</a></dt>
<dd>
<div class="block">Get the Swerve Module state.</div>
@@ -217,10 +253,30 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Get the velocity of the integrated encoder.</div>
</dd>
<dt><a href="../swervelib/simulation/SwerveIMUSimulation.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.simulation.<a href="../swervelib/simulation/SwerveIMUSimulation.html" title="class in swervelib.simulation">SwerveIMUSimulation</a></dt>
<dd>
<div class="block">Get the estimated angle of the robot.</div>
</dd>
<dt><a href="../swervelib/SwerveDrive.html#getYaw()" class="member-name-link">getYaw()</a> - Method in class swervelib.<a href="../swervelib/SwerveDrive.html" title="class in swervelib">SwerveDrive</a></dt>
<dd>
<div class="block">Gets the current yaw angle of the robot, as reported by the imu.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16448Swerve.html#getYawPitchRoll(double%5B%5D)" class="member-name-link">getYawPitchRoll(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">Fetch the yaw/pitch/roll from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/ADIS16470Swerve.html#getYawPitchRoll(double%5B%5D)" class="member-name-link">getYawPitchRoll(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">Fetch the yaw/pitch/roll from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/ADXRS450Swerve.html#getYawPitchRoll(double%5B%5D)" class="member-name-link">getYawPitchRoll(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">Fetch the yaw/pitch/roll from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#getYawPitchRoll(double%5B%5D)" class="member-name-link">getYawPitchRoll(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">Fetch the yaw/pitch/roll from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#getYawPitchRoll(double%5B%5D)" class="member-name-link">getYawPitchRoll(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">Fetch the yaw/pitch/roll from the IMU.</div>
@@ -237,6 +293,10 @@ loadScripts(document, 'script');</script>
<dd>
<div class="block">Fetch the yaw/pitch/roll from the IMU.</div>
</dd>
<dt><a href="../swervelib/imu/AnalogGyroSwerve.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/AnalogGyroSwerve.html" title="class in swervelib.imu">AnalogGyroSwerve</a></dt>
<dd>
<div class="block">Gyroscope object.</div>
</dd>
<dt><a href="../swervelib/imu/NavXSwerve.html#gyro" class="member-name-link">gyro</a> - Variable in class swervelib.imu.<a href="../swervelib/imu/NavXSwerve.html" title="class in swervelib.imu">NavXSwerve</a></dt>
<dd>
<div class="block">NavX IMU.</div>