# G-Index
index: G

# Index

A B C D E F G H I K L M N O P Q R S T U V W X Y Z
All Classes and Interfaces | All Packages | Constant Field Values

## G

generateSysIdCommand(SysIdRoutine, double, double, double) - Static method in class swervelib.SwerveDriveTest
  Creates a command that can be mapped to a button or other trigger.
getAbsoluteEncoder() - Method in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
  Get the instantiated absolute encoder Object.
getAbsoluteEncoder() - Method in class swervelib.encoders.CanAndCoderSwerve
  Get the instantiated absolute encoder Object.
getAbsoluteEncoder() - Method in class swervelib.encoders.CANCoderSwerve
  Get the instantiated absolute encoder Object.
getAbsoluteEncoder() - Method in class swervelib.encoders.PWMDutyCycleEncoderSwerve
  Get the encoder object.
getAbsoluteEncoder() - Method in class swervelib.encoders.SparkMaxAnalogEncoderSwerve
  Get the instantiated absolute encoder Object.
getAbsoluteEncoder() - Method in class swervelib.encoders.SparkMaxEncoderSwerve
  Get the instantiated absolute encoder Object.
getAbsoluteEncoder() - Method in class swervelib.encoders.SwerveAbsoluteEncoder
  Get the instantiated absolute encoder Object.
getAbsoluteEncoder() - Method in class swervelib.SwerveModule
  Get the `SwerveAbsoluteEncoder` for the `SwerveModule`.
getAbsoluteEncoderReadIssue() - Method in class swervelib.SwerveModule
  Get if the last Absolute Encoder had a read issue, such as it does not exist.
getAbsolutePosition() - Method in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.encoders.CanAndCoderSwerve
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.encoders.CANCoderSwerve
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.encoders.PWMDutyCycleEncoderSwerve
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.encoders.SparkMaxAnalogEncoderSwerve
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.encoders.SparkMaxEncoderSwerve
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.encoders.SwerveAbsoluteEncoder
  Get the absolute position of the encoder.
getAbsolutePosition() - Method in class swervelib.SwerveModule
  Get the absolute position.
getAccel() - Method in class swervelib.imu.ADIS16448Swerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.ADIS16470Swerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.ADXRS450Swerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.AnalogGyroSwerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.NavXSwerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.Pigeon2Swerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.PigeonSwerve
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.imu.SwerveIMU
  Fetch the acceleration [x, y, z] from the IMU in meters per second squared.
getAccel() - Method in class swervelib.simulation.SwerveIMUSimulation
  Fetch the acceleration [x, y, z] from the IMU in m/s/s.
getAccel() - Method in class swervelib.SwerveDrive
  Gets current acceleration of the robot in m/s/s.
getAngleMotor() - Method in class swervelib.SwerveModule
  Get the angle `SwerveMotor` for the `SwerveModule`.
getAnglePIDF() - Method in class swervelib.SwerveModule
  Get the current angle/azimuth/steering motor PIDF values.
getAppliedOutput() - Method in class swervelib.motors.SparkFlexSwerve
  Get the applied dutycycle output.
getAppliedOutput() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
  Get the applied dutycycle output.
getAppliedOutput() - Method in class swervelib.motors.SparkMaxSwerve
  Get the applied dutycycle output.
getAppliedOutput() - Method in class swervelib.motors.SwerveMotor
  Get the applied dutycycle output.
getAppliedOutput() - Method in class swervelib.motors.TalonFXSwerve
  Get the applied dutycycle output.
getAppliedOutput() - Method in class swervelib.motors.TalonSRXSwerve
  Get the applied dutycycle output.
getConfiguration() - Method in class swervelib.SwerveModule
  Fetch the `SwerveModuleConfiguration` for the `SwerveModule` with the parsed configurations.
getCosineCompensatedVelocity(SwerveModuleState) - Method in class swervelib.SwerveModule
  Get the cosine compensated velocity to set the swerve module to.
getDriveBaseRadiusMeters() - Method in class swervelib.parser.SwerveDriveConfiguration
  Calculate the Drive Base Radius
getDriveMotor() - Method in class swervelib.SwerveModule
  Get the drive `SwerveMotor` for the `SwerveModule`.
getDrivePIDF() - Method in class swervelib.SwerveModule
  Get the current drive motor PIDF values.
getFieldVelocity() - Method in class swervelib.SwerveDrive
  Gets the current field-relative velocity (x, y and omega) of the robot
getGyro() - Method in class swervelib.SwerveDrive
  Getter for the `SwerveIMU`.
getGyroRotation3d() - Method in class swervelib.simulation.SwerveIMUSimulation
  Gets the estimated gyro `Rotation3d` of the robot.
getGyroRotation3d() - Method in class swervelib.SwerveDrive
  Gets the current gyro `Rotation3d` of the robot, as reported by the imu.
getIMU() - Method in class swervelib.imu.ADIS16448Swerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.ADIS16470Swerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.ADXRS450Swerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.AnalogGyroSwerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.NavXSwerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.Pigeon2Swerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.PigeonSwerve
  Get the instantiated IMU object.
getIMU() - Method in class swervelib.imu.SwerveIMU
  Get the instantiated IMU object.
getJoystickAngle(double, double) - Method in class swervelib.SwerveController
  Get the angle in radians based off of the heading joysticks.
getMaximumAngularVelocity() - Method in class swervelib.SwerveDrive
  Get the maximum angular velocity, either `SwerveDrive.attainableMaxRotationalVelocityRadiansPerSecond` or `SwerveControllerConfiguration.maxAngularVelocity`.
getMaximumVelocity() - Method in class swervelib.SwerveDrive
  Get the maximum velocity from `SwerveDrive.attainableMaxTranslationalSpeedMetersPerSecond` or `SwerveDrive.maxSpeedMPS` whichever is higher.
getModuleConfigurationByName(String, SwerveDriveConfiguration) - Static method in class swervelib.parser.SwerveParser
  Get the swerve module by the json name.
getModuleMap() - Method in class swervelib.SwerveDrive
  Get the `SwerveModule`'s as a `HashMap` where the key is the swerve module configuration name.
getModulePositions() - Method in class swervelib.SwerveDrive
  Gets the current module positions (azimuth and wheel position (meters)).
getModules() - Method in class swervelib.SwerveDrive
  Get the `SwerveModule`s associated with the `SwerveDrive`.
getMotor() - Method in class swervelib.motors.SparkFlexSwerve
  Get the motor object from the module.
getMotor() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
  Get the motor object from the module.
getMotor() - Method in class swervelib.motors.SparkMaxSwerve
  Get the motor object from the module.
getMotor() - Method in class swervelib.motors.SwerveMotor
  Get the motor object from the module.
getMotor() - Method in class swervelib.motors.TalonFXSwerve
  Get the motor object from the module.
getMotor() - Method in class swervelib.motors.TalonSRXSwerve
  Get the motor object from the module.
getOdometryHeading() - Method in class swervelib.SwerveDrive
  Fetch the latest odometry heading, should be trusted over `SwerveDrive.getYaw()`.
getPitch() - Method in class swervelib.simulation.SwerveIMUSimulation
  Pitch is not simulated currently, always returns 0.
getPitch() - Method in class swervelib.SwerveDrive
  Gets the current pitch angle of the robot, as reported by the imu.
getPose() - Method in class swervelib.SwerveDrive
  Gets the current pose (position and rotation) of the robot, as reported by odometry.
getPosition() - Method in class swervelib.motors.SparkFlexSwerve
  Get the position of the integrated encoder.
getPosition() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
  Get the position of the integrated encoder.
getPosition() - Method in class swervelib.motors.SparkMaxSwerve
  Get the position of the integrated encoder.
getPosition() - Method in class swervelib.motors.SwerveMotor
  Get the position of the integrated encoder.
getPosition() - Method in class swervelib.motors.TalonFXSwerve
  Get the position of the integrated encoder.
getPosition() - Method in class swervelib.motors.TalonSRXSwerve
  Get the position of the integrated encoder.
getPosition() - Method in class swervelib.simulation.SwerveModuleSimulation
  Get the simulated swerve module position.
getPosition() - Method in class swervelib.SwerveModule
  Get the position of the swerve module.
getRawAbsolutePosition() - Method in class swervelib.SwerveModule
  Get the absolute position.
getRawRotation3d() - Method in class swervelib.imu.ADIS16448Swerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.ADIS16470Swerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.ADXRS450Swerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.AnalogGyroSwerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.NavXSwerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.Pigeon2Swerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.PigeonSwerve
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawRotation3d() - Method in class swervelib.imu.SwerveIMU
  Fetch the `Rotation3d` from the IMU without any zeroing.
getRawTargetSpeeds(double, double, double) - Method in class swervelib.SwerveController
  Get the `ChassisSpeeds` based of raw speeds desired in meters/second and heading in radians.
getRawTargetSpeeds(double, double, double, double) - Method in class swervelib.SwerveController
  Get the `ChassisSpeeds` based of raw speeds desired in meters/second and heading in radians.
getRelativePosition() - Method in class swervelib.SwerveModule
  Get the relative angle in degrees.
getRobotVelocity() - Method in class swervelib.SwerveDrive
  Gets the current robot-relative velocity (x, y and omega) of the robot
getRoll() - Method in class swervelib.simulation.SwerveIMUSimulation
  Roll is not simulated currently, always returns 0.
getRoll() - Method in class swervelib.SwerveDrive
  Gets the current roll angle of the robot, as reported by the imu.
getRotation3d() - Method in class swervelib.imu.ADIS16448Swerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.ADIS16470Swerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.ADXRS450Swerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.AnalogGyroSwerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.NavXSwerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.Pigeon2Swerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.PigeonSwerve
  Fetch the `Rotation3d` from the IMU.
getRotation3d() - Method in class swervelib.imu.SwerveIMU
  Fetch the `Rotation3d` from the IMU.
getState() - Method in class swervelib.simulation.SwerveModuleSimulation
  Get the `SwerveModuleState` of the simulated module.
getState() - Method in class swervelib.SwerveModule
  Get the Swerve Module state.
getStates() - Method in class swervelib.SwerveDrive
  Gets the current module states (azimuth and velocity)
getStrings(Alert.AlertType) - Method in class swervelib.telemetry.Alert.SendableAlerts
  Get alerts based off of type.
getSwerveController() - Method in class swervelib.SwerveDrive
  Helper function to get the `SwerveDrive.swerveController` for the `SwerveDrive` which can be used to generate `ChassisSpeeds` for the robot to orient it correctly given axis or angles, and apply `SlewRateLimiter` to given inputs.
getSwerveModule(SwerveModule[], boolean, boolean) - Static method in class swervelib.math.SwerveMath
  Get the fruthest module from center based on the module locations.
getSwerveModulePoses(Pose2d) - Method in class swervelib.SwerveDrive
  Get the swerve module poses and on the field relative to the robot.
getTargetSpeeds(double, double, double, double, double) - Method in class swervelib.SwerveController
  Get the chassis speeds based on controller input of 1 joystick [-1,1] and an angle.
getTargetSpeeds(double, double, double, double, double, double) - Method in class swervelib.SwerveController
  Get the chassis speeds based on controller input of 2 joysticks.
getTranslation2d(ChassisSpeeds) - Static method in class swervelib.SwerveController
  Helper function to get the `Translation2d` of the chassis speeds given the `ChassisSpeeds`.
getValue() - Method in class swervelib.parser.Cache
  Get the most up to date cached value.
getVelocity() - Method in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.encoders.CanAndCoderSwerve
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.encoders.CANCoderSwerve
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.encoders.PWMDutyCycleEncoderSwerve
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.encoders.SparkMaxAnalogEncoderSwerve
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.encoders.SparkMaxEncoderSwerve
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.encoders.SwerveAbsoluteEncoder
  Get the velocity in degrees/sec.
getVelocity() - Method in class swervelib.motors.SparkFlexSwerve
  Get the velocity of the integrated encoder.
getVelocity() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
  Get the velocity of the integrated encoder.
getVelocity() - Method in class swervelib.motors.SparkMaxSwerve
  Get the velocity of the integrated encoder.
getVelocity() - Method in class swervelib.motors.SwerveMotor
  Get the velocity of the integrated encoder.
getVelocity() - Method in class swervelib.motors.TalonFXSwerve
  Get the velocity of the integrated encoder.
getVelocity() - Method in class swervelib.motors.TalonSRXSwerve
  Get the velocity of the integrated encoder.
getVoltage() - Method in class swervelib.motors.SparkFlexSwerve
  Get the voltage output of the motor controller.
getVoltage() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
  Get the voltage output of the motor controller.
getVoltage() - Method in class swervelib.motors.SparkMaxSwerve
  Get the voltage output of the motor controller.
getVoltage() - Method in class swervelib.motors.SwerveMotor
  Get the voltage output of the motor controller.
getVoltage() - Method in class swervelib.motors.TalonFXSwerve
  Get the voltage output of the motor controller.
getVoltage() - Method in class swervelib.motors.TalonSRXSwerve
  Get the voltage output of the motor controller.
getYaw() - Method in class swervelib.simulation.SwerveIMUSimulation
  Get the estimated angle of the robot.
getYaw() - Method in class swervelib.SwerveDrive
  Gets the current yaw angle of the robot, as reported by the imu.
groups - Static variable in class swervelib.telemetry.Alert
  Group of the alert.
gyro - Variable in class swervelib.imu.AnalogGyroSwerve
  Gyroscope object.
gyro - Variable in class swervelib.imu.NavXSwerve
  NavX IMU.

A B C D E F G H I K L M N O P Q R S T U V W X Y Z
All Classes and Interfaces | All Packages | Constant Field Values