Index
All Classes and Interfaces|All Packages
A
- absoluteEncoder - Variable in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Absolute encoder attached to the SparkMax (if exists)
- absoluteEncoder - Variable in class swervelib.motors.SparkMaxSwerve
-
Absolute encoder attached to the SparkMax (if exists)
- absoluteEncoder - Variable in class swervelib.parser.SwerveModuleConfiguration
-
The Absolute Encoder for the swerve module.
- absoluteEncoderInverted - Variable in class swervelib.parser.json.ModuleJson
-
Absolute encoder inversion state.
- absoluteEncoderInverted - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Whether the absolute encoder is inverted.
- absoluteEncoderOffset - Variable in class swervelib.parser.json.ModuleJson
-
Absolute encoder offset from 0 in degrees.
- addSlewRateLimiters(SlewRateLimiter, SlewRateLimiter, SlewRateLimiter) - Method in class swervelib.SwerveController
-
Add slew rate limiters to all controls.
- addTalonFX(TalonFX, double, double) - Method in class swervelib.simulation.ctre.PhysicsSim
-
Adds a TalonFX controller to the simulator.
- addTalonFX(TalonFX, double, double, boolean) - Method in class swervelib.simulation.ctre.PhysicsSim
-
Adds a TalonFX controller to the simulator.
- addTalonSRX(TalonSRX, double, double) - Method in class swervelib.simulation.ctre.PhysicsSim
-
Adds a TalonSRX controller to the simulator.
- addTalonSRX(TalonSRX, double, double, boolean) - Method in class swervelib.simulation.ctre.PhysicsSim
-
Adds a TalonSRX controller to the simulator.
- addVictorSPX(VictorSPX) - Method in class swervelib.simulation.ctre.PhysicsSim
-
Adds a VictorSPX controller to the simulator.
- addVisionMeasurement(Pose2d, double) - Method in class swervelib.math.SwervePoseEstimator2
-
Adds a vision measurement to the Kalman Filter.
- addVisionMeasurement(Pose2d, double, boolean, double) - Method in class swervelib.SwerveDrive
-
Add a vision measurement to the
SwerveDrivePoseEstimatorand update theSwerveIMUgyro reading with the given timestamp of the vision measurement. - addVisionMeasurement(Pose2d, double, boolean, Matrix<N3, N1>) - Method in class swervelib.SwerveDrive
-
Add a vision measurement to the
SwerveDrivePoseEstimatorand update theSwerveIMUgyro reading with the given timestamp of the vision measurement. - addVisionMeasurement(Pose2d, double, Matrix<N3, N1>) - Method in class swervelib.math.SwervePoseEstimator2
-
Adds a vision measurement to the Kalman Filter.
- ADIS16448Swerve - Class in swervelib.imu
-
IMU Swerve class for the
ADIS16448_IMUdevice. - ADIS16448Swerve() - Constructor for class swervelib.imu.ADIS16448Swerve
-
Construct the ADIS16448 imu and reset default configurations.
- ADIS16470Swerve - Class in swervelib.imu
-
IMU Swerve class for the
ADIS16470_IMUdevice. - ADIS16470Swerve() - Constructor for class swervelib.imu.ADIS16470Swerve
-
Construct the ADIS16470 imu and reset default configurations.
- ADXRS450Swerve - Class in swervelib.imu
-
IMU Swerve class for the
ADXRS450_Gyrodevice. - ADXRS450Swerve() - Constructor for class swervelib.imu.ADXRS450Swerve
-
Construct the ADXRS450 imu and reset default configurations.
- AnalogAbsoluteEncoderSwerve - Class in swervelib.encoders
-
Swerve Absolute Encoder for Thrifty Encoders and other analog encoders.
- AnalogAbsoluteEncoderSwerve(int) - Constructor for class swervelib.encoders.AnalogAbsoluteEncoderSwerve
-
Construct the Encoder given the analog input channel.
- AnalogAbsoluteEncoderSwerve(AnalogInput) - Constructor for class swervelib.encoders.AnalogAbsoluteEncoderSwerve
-
Construct the Thrifty Encoder as a Swerve Absolute Encoder.
- AnalogGyroSwerve - Class in swervelib.imu
-
Creates a IMU for
AnalogGyrodevices, only uses yaw. - AnalogGyroSwerve(int) - Constructor for class swervelib.imu.AnalogGyroSwerve
-
Analog port in which the gyroscope is connected.
- angle - Variable in class swervelib.parser.json.ModuleJson
-
Angle motor device configuration.
- angle - Variable in class swervelib.parser.json.modules.BoolMotorJson
-
Angle motor inversion state.
- angle - Variable in class swervelib.parser.json.PIDFPropertiesJson
-
The PIDF with Integral Zone used for the angle motor.
- angleEncoderPulsePerRevolution - Variable in class swervelib.parser.json.ModuleJson
-
The angle encoder pulse per revolution override.
- angleEncoderPulsePerRotation - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Angle motor encoder pulse per rotation.
- angleGearRatio - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Angle gear ratio.
- angleJoystickRadiusDeadband - Variable in class swervelib.parser.json.ControllerPropertiesJson
-
The minimum radius of the angle control joystick to allow for heading adjustment of the robot.
- angleJoyStickRadiusDeadband - Variable in class swervelib.parser.SwerveControllerConfiguration
-
hypotenuse deadband for the robot angle control joystick.
- angleLimiter - Variable in class swervelib.SwerveController
-
SlewRateLimiterfor angular movement in radians/second. - angleMotor - Variable in class swervelib.parser.SwerveModuleConfiguration
-
The drive motor and angle motor of this swerve module.
- angleMotorCurrentLimit - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Current limits for the Swerve Module.
- angleMotorEncoderPulsePerRevolution - Variable in class swervelib.parser.SwerveModuleConfiguration
-
The integrated encoder pulse per revolution.
- angleMotorFreeSpeedRPM - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
DEPRECATED: No longer needed, tune
PhysicalPropertiesJson.moduleFeedForwardClosedLoopinstead. - angleMotorInverted - Variable in class swervelib.parser.SwerveModuleConfiguration
-
State of inversion of the angle motor.
- angleMotorRampRate - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
The time it takes for the motor to go from 0 to full throttle in seconds.
- angleOffset - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Angle offset in degrees for the Swerve Module.
- anglePIDF - Variable in class swervelib.parser.SwerveModuleConfiguration
-
PIDF configuration options for the angle motor closed-loop PID controller.
- antiJitter(SwerveModuleState2, SwerveModuleState2, double) - Static method in class swervelib.math.SwerveMath
-
Perform anti-jitter within modules if the speed requested is too low.
- applyDeadband(double, boolean, double) - Static method in class swervelib.math.SwerveMath
-
Algebraically apply a deadband using a piece wise function.
- attainableMaxRotationalVelocityRadiansPerSecond - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Max module speed in meters per second.
- attainableMaxTranslationalSpeedMetersPerSecond - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Max module speed in meters per second.
B
- BoolMotorJson - Class in swervelib.parser.json.modules
-
Inverted motor JSON parsed class.
- BoolMotorJson() - Constructor for class swervelib.parser.json.modules.BoolMotorJson
- burnFlash() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Save the configurations from flash to EEPROM.
- burnFlash() - Method in class swervelib.motors.SparkMaxSwerve
-
Save the configurations from flash to EEPROM.
- burnFlash() - Method in class swervelib.motors.SwerveMotor
-
Save the configurations from flash to EEPROM.
- burnFlash() - Method in class swervelib.motors.TalonFXSwerve
-
Save the configurations from flash to EEPROM.
- burnFlash() - Method in class swervelib.motors.TalonSRXSwerve
-
Save the configurations from flash to EEPROM.
C
- calculateDegreesPerSteeringRotation(double, double) - Static method in class swervelib.math.SwerveMath
-
Calculate the degrees per steering rotation for the integrated encoder.
- calculateMaxAcceleration(double) - Static method in class swervelib.math.SwerveMath
-
Calculate the practical maximum acceleration of the robot using the wheel coefficient of friction.
- calculateMaxAcceleration(double, double, double, double, double) - Static method in class swervelib.math.SwerveMath
-
Calculate the maximum theoretical acceleration without friction.
- calculateMaxAngularVelocity(double, double, double) - Static method in class swervelib.math.SwerveMath
-
Calculate the maximum angular velocity.
- calculateMetersPerRotation(double, double, double) - Static method in class swervelib.math.SwerveMath
-
Calculate the meters per rotation for the integrated encoder.
- CanAndCoderSwerve - Class in swervelib.encoders
-
HELIUM
CANandcoderfrom ReduxRobotics absolute encoder, attached through the CAN bus. - CanAndCoderSwerve(int) - Constructor for class swervelib.encoders.CanAndCoderSwerve
-
Create the
CANandcoder - canbus - Variable in class swervelib.parser.json.DeviceJson
-
The CAN bus name which the device resides on if using CAN.
- CANCoderSwerve - Class in swervelib.encoders
-
Swerve Absolute Encoder for CTRE CANCoders.
- CANCoderSwerve(int) - Constructor for class swervelib.encoders.CANCoderSwerve
-
Initialize the CANCoder on the standard CANBus.
- CANCoderSwerve(int, String) - Constructor for class swervelib.encoders.CANCoderSwerve
-
Initialize the CANCoder on the CANivore.
- chassisVelocityCorrection - Variable in class swervelib.SwerveDrive
-
Correct chassis velocity in
SwerveDrive.drive(Translation2d, double, boolean, boolean)using 254's correction. - clearStickyFaults() - Method in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
-
Clear sticky faults on the encoder.
- clearStickyFaults() - Method in class swervelib.encoders.CanAndCoderSwerve
-
Clear sticky faults on the encoder.
- clearStickyFaults() - Method in class swervelib.encoders.CANCoderSwerve
-
Clear sticky faults on the encoder.
- clearStickyFaults() - Method in class swervelib.encoders.SparkMaxEncoderSwerve
-
Clear sticky faults on the encoder.
- clearStickyFaults() - Method in class swervelib.encoders.SwerveAbsoluteEncoder
-
Clear sticky faults on the encoder.
- clearStickyFaults() - Method in class swervelib.imu.ADIS16448Swerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.ADIS16470Swerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.ADXRS450Swerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.AnalogGyroSwerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.NavXSwerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.Pigeon2Swerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.PigeonSwerve
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.imu.SwerveIMU
-
Clear sticky faults on IMU.
- clearStickyFaults() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Clear the sticky faults on the motor controller.
- clearStickyFaults() - Method in class swervelib.motors.SparkMaxSwerve
-
Clear the sticky faults on the motor controller.
- clearStickyFaults() - Method in class swervelib.motors.SwerveMotor
-
Clear the sticky faults on the motor controller.
- clearStickyFaults() - Method in class swervelib.motors.TalonFXSwerve
-
Clear the sticky faults on the motor controller.
- clearStickyFaults() - Method in class swervelib.motors.TalonSRXSwerve
-
Clear the sticky faults on the motor controller.
- config - Variable in class swervelib.SwerveController
-
SwerveControllerConfigurationobject storing data to generate thePIDControllerfor controlling the robot heading, and deadband for heading joystick. - configuration - Variable in class swervelib.SwerveModule
-
Swerve module configuration options.
- configure(boolean) - Method in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
-
Configure the absolute encoder to read from [0, 360) per second.
- configure(boolean) - Method in class swervelib.encoders.CanAndCoderSwerve
-
Configure the CANandCoder to read from [0, 360) per second.
- configure(boolean) - Method in class swervelib.encoders.CANCoderSwerve
-
Configure the absolute encoder to read from [0, 360) per second.
- configure(boolean) - Method in class swervelib.encoders.SparkMaxEncoderSwerve
-
Configure the absolute encoder to read from [0, 360) per second.
- configure(boolean) - Method in class swervelib.encoders.SwerveAbsoluteEncoder
-
Configure the absolute encoder to read from [0, 360) per second.
- configureCANStatusFrames(int) - Method in class swervelib.motors.TalonFXSwerve
-
Set the CAN status frames.
- configureCANStatusFrames(int) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the CAN status frames.
- configureCANStatusFrames(int, int, int, int, int) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the CAN status frames.
- configureCANStatusFrames(int, int, int, int, int) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the CAN status frames.
- configureCANStatusFrames(int, int, int, int, int, int, int, int, int, int, int) - Method in class swervelib.motors.TalonFXSwerve
-
Set the CAN status frames.
- configureCANStatusFrames(int, int, int, int, int, int, int, int, int, int, int) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the CAN status frames.
- configureIntegratedEncoder(double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Configure the integrated encoder for the swerve module.
- configureIntegratedEncoder(double) - Method in class swervelib.motors.SparkMaxSwerve
-
Configure the integrated encoder for the swerve module.
- configureIntegratedEncoder(double) - Method in class swervelib.motors.SwerveMotor
-
Configure the integrated encoder for the swerve module.
- configureIntegratedEncoder(double) - Method in class swervelib.motors.TalonFXSwerve
-
Configure the integrated encoder for the swerve module.
- configureIntegratedEncoder(double) - Method in class swervelib.motors.TalonSRXSwerve
-
Configure the integrated encoder for the swerve module.
- configurePIDF(PIDFConfig) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Configure the PIDF values for the closed loop controller.
- configurePIDF(PIDFConfig) - Method in class swervelib.motors.SparkMaxSwerve
-
Configure the PIDF values for the closed loop controller.
- configurePIDF(PIDFConfig) - Method in class swervelib.motors.SwerveMotor
-
Configure the PIDF values for the closed loop controller.
- configurePIDF(PIDFConfig) - Method in class swervelib.motors.TalonFXSwerve
-
Configure the PIDF values for the closed loop controller.
- configurePIDF(PIDFConfig) - Method in class swervelib.motors.TalonSRXSwerve
-
Configure the PIDF values for the closed loop controller.
- configurePIDWrapping(double, double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Configure the PID wrapping for the position closed loop controller.
- configurePIDWrapping(double, double) - Method in class swervelib.motors.SparkMaxSwerve
-
Configure the PID wrapping for the position closed loop controller.
- configurePIDWrapping(double, double) - Method in class swervelib.motors.SwerveMotor
-
Configure the PID wrapping for the position closed loop controller.
- configurePIDWrapping(double, double) - Method in class swervelib.motors.TalonFXSwerve
-
Configure the PID wrapping for the position closed loop controller.
- configurePIDWrapping(double, double) - Method in class swervelib.motors.TalonSRXSwerve
-
Configure the PID wrapping for the position closed loop controller.
- controllerPropertiesJson - Static variable in class swervelib.parser.SwerveParser
-
Parsed controllerproperties.json
- ControllerPropertiesJson - Class in swervelib.parser.json
-
SwerveControllerparsed class. - ControllerPropertiesJson() - Constructor for class swervelib.parser.json.ControllerPropertiesJson
- convertToNativeSensorUnits(double, double) - Method in class swervelib.motors.TalonFXSwerve
-
Convert the setpoint into native sensor units.
- convertToNativeSensorUnits(double, double) - Method in class swervelib.motors.TalonSRXSwerve
-
Convert the setpoint into native sensor units.
- createControllerConfiguration(SwerveDriveConfiguration) - Method in class swervelib.parser.json.ControllerPropertiesJson
-
Create the
SwerveControllerConfigurationbased on parsed and given data. - createDriveFeedforward() - Method in class swervelib.parser.SwerveModuleConfiguration
-
Create the drive feedforward for swerve modules.
- createEncoder(SwerveMotor) - Method in class swervelib.parser.json.DeviceJson
-
Create a
SwerveAbsoluteEncoderfrom the current configuration. - createIMU() - Method in class swervelib.parser.json.DeviceJson
-
Create a
SwerveIMUfrom the given configuration. - createIntegratedEncoder(SwerveMotor) - Method in class swervelib.parser.json.DeviceJson
-
Create a
SwerveAbsoluteEncoderfrom the data port on the motor controller. - createModuleConfiguration(PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, String) - Method in class swervelib.parser.json.ModuleJson
-
Create the swerve module configuration based off of parsed data.
- createModules(SwerveModuleConfiguration[]) - Method in class swervelib.parser.SwerveDriveConfiguration
-
Create modules based off of the SwerveModuleConfiguration.
- createMotor(boolean) - Method in class swervelib.parser.json.DeviceJson
-
Create a
SwerveMotorfrom the given configuration. - createPhysicalProperties(double) - Method in class swervelib.parser.json.PhysicalPropertiesJson
-
Create the physical characteristics based off the parsed data.
- createPIDController() - Method in class swervelib.parser.PIDFConfig
-
Create a PIDController from the PID values.
- createSwerveDrive() - Method in class swervelib.parser.SwerveParser
-
Create
SwerveDrivefrom JSON configuration directory. - currentLimit - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
The current limit in AMPs to apply to the motors.
D
- d - Variable in class swervelib.parser.PIDFConfig
-
Derivative Gain for PID.
- desaturateWheelSpeeds(SwerveModuleState2[], double) - Static method in class swervelib.math.SwerveKinematics2
-
Renormalizes the wheel speeds if any individual speed is above the specified maximum.
- desaturateWheelSpeeds(SwerveModuleState2[], ChassisSpeeds, double, double, double) - Static method in class swervelib.math.SwerveKinematics2
-
Renormalizes the wheel speeds if any individual speed is above the specified maximum, as well as getting rid of joystick saturation at edges of joystick.
- desiredChassisSpeeds - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
Describes the desired forward, sideways and angular velocity of the robot.
- desiredStates - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
An array of rotation and velocity values describing the desired state of each swerve module
- DeviceJson - Class in swervelib.parser.json
-
Device JSON parsed class.
- DeviceJson() - Constructor for class swervelib.parser.json.DeviceJson
- disableSecondOrderKinematics() - Method in class swervelib.SwerveDrive
-
Disable second order kinematics.
- drive - Variable in class swervelib.parser.json.ModuleJson
-
Drive motor device configuration.
- drive - Variable in class swervelib.parser.json.modules.BoolMotorJson
-
Drive motor inversion state.
- drive - Variable in class swervelib.parser.json.PIDFPropertiesJson
-
The PIDF with Integral Zone used for the drive motor.
- drive(Translation2d, double, boolean, boolean) - Method in class swervelib.SwerveDrive
-
The primary method for controlling the drivebase.
- drive(Translation2d, double, boolean, boolean, boolean) - Method in class swervelib.SwerveDrive
-
The primary method for controlling the drivebase.
- driveEncoderPulsePerRotation - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Drive motor encoder pulse per rotation.
- driveGearRatio - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Drive gear ratio.
- driveMotor - Variable in class swervelib.parser.SwerveModuleConfiguration
-
The drive motor and angle motor of this swerve module.
- driveMotorCurrentLimit - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Current limits for the Swerve Module.
- driveMotorInverted - Variable in class swervelib.parser.SwerveModuleConfiguration
-
State of inversion of the drive motor.
- driveMotorRampRate - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
The time it takes for the motor to go from 0 to full throttle in seconds.
E
- enableSecondOrderKinematics() - Method in class swervelib.SwerveDrive
-
Enable second order kinematics for tracking purposes but completely untuned.
- enableSecondOrderKinematics(double) - Method in class swervelib.SwerveDrive
-
Enable second order kinematics for simulation and modifying the feedforward.
- enableSecondOrderKinematics(int) - Method in class swervelib.SwerveDrive
-
Enable second order kinematics with calculated values for the feedforward and return the value used.
- encoder - Variable in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
-
Encoder as Analog Input.
- encoder - Variable in class swervelib.encoders.CanAndCoderSwerve
-
The
CANandcoderrepresenting the CANandCoder on the CAN bus. - encoder - Variable in class swervelib.encoders.CANCoderSwerve
-
CANCoder with WPILib sendable and support.
- encoder - Variable in class swervelib.encoders.SparkMaxEncoderSwerve
-
The
AbsoluteEncoderrepresenting the duty cycle encoder attached to the SparkMax. - encoder - Variable in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Integrated encoder.
- encoder - Variable in class swervelib.motors.SparkMaxSwerve
-
Integrated encoder.
- encoder - Variable in class swervelib.parser.json.ModuleJson
-
Absolute encoder device configuration.
- encoderPulsePerRotation - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
Encoder pulse per rotation for non-integrated encoders.
F
- f - Variable in class swervelib.parser.PIDFConfig
-
Feedforward value for PID.
- factoryDefault() - Method in class swervelib.encoders.AnalogAbsoluteEncoderSwerve
-
Reset the encoder to factory defaults.
- factoryDefault() - Method in class swervelib.encoders.CanAndCoderSwerve
-
Reset the encoder to factory defaults.
- factoryDefault() - Method in class swervelib.encoders.CANCoderSwerve
-
Reset the encoder to factory defaults.
- factoryDefault() - Method in class swervelib.encoders.SparkMaxEncoderSwerve
-
Reset the encoder to factory defaults.
- factoryDefault() - Method in class swervelib.encoders.SwerveAbsoluteEncoder
-
Reset the encoder to factory defaults.
- factoryDefault() - Method in class swervelib.imu.ADIS16448Swerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.ADIS16470Swerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.ADXRS450Swerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.AnalogGyroSwerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.NavXSwerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.Pigeon2Swerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.PigeonSwerve
-
Reset IMU to factory default.
- factoryDefault() - Method in class swervelib.imu.SwerveIMU
-
Reset IMU to factory default.
- factoryDefaults() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Configure the factory defaults.
- factoryDefaults() - Method in class swervelib.motors.SparkMaxSwerve
-
Configure the factory defaults.
- factoryDefaults() - Method in class swervelib.motors.SwerveMotor
-
Configure the factory defaults.
- factoryDefaults() - Method in class swervelib.motors.TalonFXSwerve
-
Configure the factory defaults.
- factoryDefaults() - Method in class swervelib.motors.TalonSRXSwerve
-
Configure the factory defaults.
- feedforward - Variable in class swervelib.SwerveModule
-
Feedforward for drive motor during closed loop control.
- field - Variable in class swervelib.SwerveDrive
-
Field object.
- forwardDirection - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The direction the robot should be facing when the "Robot Rotation" is zero or blank.
- front - Variable in class swervelib.parser.json.modules.LocationJson
-
Location of the swerve module in inches from the center of the robot horizontally.
G
- gearRatio - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
Gear ratio for the motors, number of times the motor has to spin before the wheel rotates a single time.
- 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.SparkMaxEncoderSwerve
-
Get the instantiated absolute encoder Object.
- getAbsoluteEncoder() - Method in class swervelib.encoders.SwerveAbsoluteEncoder
-
Get the instantiated absolute encoder Object.
- 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.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
SwerveMotorfor theSwerveModule. - getConfiguration() - Method in class swervelib.SwerveModule
-
Fetch the
SwerveModuleConfigurationfor theSwerveModulewith the parsed configurations. - getDriveMotor() - Method in class swervelib.SwerveModule
-
Get the drive
SwerveMotorfor theSwerveModule. - getEstimatedPosition() - Method in class swervelib.math.SwervePoseEstimator2
-
Gets the estimated robot pose.
- getFieldVelocity() - Method in class swervelib.SwerveDrive
-
Gets the current field-relative velocity (x, y and omega) of the robot
- getGyroRotation3d() - Method in class swervelib.simulation.SwerveIMUSimulation
-
Gets the estimated gyro
Rotation3dof the robot. - getGyroRotation3d() - Method in class swervelib.SwerveDrive
-
Gets the current gyro
Rotation3dof 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.
- getInstance() - Static method in class swervelib.simulation.ctre.PhysicsSim
-
Gets the robot simulator instance.
- getJoystickAngle(double, double) - Method in class swervelib.SwerveController
-
Get the angle in radians based off of the heading joysticks.
- getModuleConfigurationByName(String, SwerveDriveConfiguration) - Static method in class swervelib.parser.SwerveParser
-
Get the swerve module by the json 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
SwerveModules associated with theSwerveDrive. - 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.
- 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.
- getPoseMeters() - Method in class swervelib.math.SwerveDriveOdometry2
-
Returns the position of the robot on the field.
- 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.
- getPositionEncoderConversion(boolean) - Method in class swervelib.parser.SwerveModuleConfiguration
-
Get the encoder conversion for position encoders.
- getPulsePerRotation(int) - Method in class swervelib.parser.json.DeviceJson
-
Get the encoder pulse per rotation based off of the encoder type.
- getRawRotation3d() - Method in class swervelib.imu.ADIS16448Swerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.ADIS16470Swerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.ADXRS450Swerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.AnalogGyroSwerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.NavXSwerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.Pigeon2Swerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.PigeonSwerve
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawRotation3d() - Method in class swervelib.imu.SwerveIMU
-
Fetch the
Rotation3dfrom the IMU without any zeroing. - getRawTargetSpeeds(double, double, double) - Method in class swervelib.SwerveController
-
Get the
ChassisSpeedsbased of raw speeds desired in meters/second and heading in radians. - getRawTargetSpeeds(double, double, double, double) - Method in class swervelib.SwerveController
-
Get the
ChassisSpeedsbased 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
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.ADIS16470Swerve
-
Fetch the
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.ADXRS450Swerve
-
Fetch the
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.AnalogGyroSwerve
-
Fetch the
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.NavXSwerve
-
Fetch the
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.Pigeon2Swerve
-
Fetch the
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.PigeonSwerve
-
Fetch the
Rotation3dfrom the IMU. - getRotation3d() - Method in class swervelib.imu.SwerveIMU
-
Fetch the
Rotation3dfrom the IMU. - getState() - Method in class swervelib.simulation.SwerveModuleSimulation
-
Get the
SwerveModuleState2of 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)
- getSwerveController() - Method in class swervelib.SwerveDrive
-
Helper function to get the
SwerveDrive.swerveControllerfor theSwerveDrivewhich can be used to generateChassisSpeedsfor the robot to orient it correctly given axis or angles, and applySlewRateLimiterto 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) - 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) - 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
Translation2dof the chassis speeds given theChassisSpeeds. - 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.
- 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.
H
- heading - Variable in class swervelib.parser.json.ControllerPropertiesJson
-
The PID used to control the robot heading.
- headingCalculate(double, double) - Method in class swervelib.SwerveController
-
Calculate the angular velocity given the current and target heading angle in radians.
- headingPIDF - Variable in class swervelib.parser.SwerveControllerConfiguration
-
PIDF for the heading of the robot.
- HIGH - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Full swerve drive data is sent back in both human and machine readable forms.
I
- i - Variable in class swervelib.parser.PIDFConfig
-
Integral Gain for PID.
- id - Variable in class swervelib.parser.json.DeviceJson
-
The CAN ID or pin ID of the device.
- imu - Variable in class swervelib.parser.json.SwerveDriveJson
-
Robot IMU used to determine heading of the robot.
- imu - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Swerve IMU
- invert() - Method in class swervelib.math.SwerveModuleState2
-
Invert the swerve module state.
- inverted - Variable in class swervelib.parser.json.ModuleJson
-
Defines which motors are inverted.
- invertedIMU - Variable in class swervelib.parser.json.SwerveDriveJson
-
Invert the IMU of the robot.
- invertedIMU - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Invert the imu measurements.
- invertOdometry - Variable in class swervelib.SwerveDrive
-
Invert odometry readings of drive motor positions, used as a patch for debugging currently.
- isAttachedAbsoluteEncoder() - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Queries whether the absolute encoder is directly attached to the motor controller.
- isAttachedAbsoluteEncoder() - Method in class swervelib.motors.SparkMaxSwerve
-
Queries whether the absolute encoder is directly attached to the motor controller.
- isAttachedAbsoluteEncoder() - Method in class swervelib.motors.SwerveMotor
-
Queries whether the absolute encoder is directly attached to the motor controller.
- isAttachedAbsoluteEncoder() - Method in class swervelib.motors.TalonFXSwerve
-
Queries whether the absolute encoder is directly attached to the motor controller.
- isAttachedAbsoluteEncoder() - Method in class swervelib.motors.TalonSRXSwerve
-
Queries whether the absolute encoder is directly attached to the motor controller.
- isDriveMotor - Variable in class swervelib.motors.SwerveMotor
-
Whether the swerve motor is a drive motor.
- isSimulation - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
State of simulation of the Robot, used to optimize retrieval.
- iz - Variable in class swervelib.parser.PIDFConfig
-
Integral zone of the PID.
K
- kinematics - Variable in class swervelib.SwerveDrive
-
Swerve Kinematics object utilizing second order kinematics.
L
- lastAngleScalar - Variable in class swervelib.SwerveController
-
Last angle as a scalar [-1,1] the robot was set to.
- lastState - Variable in class swervelib.SwerveModule
-
Last swerve module state applied.
- left - Variable in class swervelib.parser.json.modules.LocationJson
-
Location of the swerve module in inches from the center of the robot vertically.
- limitVelocity(Translation2d, ChassisSpeeds, Pose2d, double, double, List<Matter>, SwerveDriveConfiguration) - Static method in class swervelib.math.SwerveMath
-
Limits a commanded velocity to prevent exceeding the maximum acceleration given by
SwerveMath.calcMaxAccel(edu.wpi.first.math.geometry.Rotation2d, java.util.List<swervelib.math.Matter>, double, swervelib.parser.SwerveDriveConfiguration). - location - Variable in class swervelib.parser.json.ModuleJson
-
The location of the swerve module from the center of the robot in inches.
- LocationJson - Class in swervelib.parser.json.modules
-
Location JSON parsed class.
- LocationJson() - Constructor for class swervelib.parser.json.modules.LocationJson
- lockPose() - Method in class swervelib.SwerveDrive
-
Point all modules toward the robot center, thus making the robot very difficult to move.
- LOW - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Low telemetry data, only post the robot position on the field.
M
- MACHINE - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Only send the machine readable data related to swerve drive.
- mass - Variable in class swervelib.math.Matter
-
Mass in kg of object.
- massMoment() - Method in class swervelib.math.Matter
-
Get the center mass of the object.
- Matter - Class in swervelib.math
-
Object with significant mass that needs to be taken into account.
- Matter(Translation3d, double) - Constructor for class swervelib.math.Matter
-
Construct an object representing some significant matter on the robot.
- max - Variable in class swervelib.parser.deserializer.PIDFRange
-
Maximum value.
- maxAngularVelocity - Variable in class swervelib.parser.SwerveControllerConfiguration
-
Maximum angular velocity in rad/s
- maxAngularVelocity - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The maximum achievable angular velocity of the robot.
- maxSpeed - Variable in class swervelib.parser.json.SwerveDriveJson
-
Maximum robot speed in feet per second.
- maxSpeed - Variable in class swervelib.parser.SwerveControllerConfiguration
-
Maximum robot speed in meters per second.
- maxSpeed - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Max module speed in meters per second.
- maxSpeed - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Maximum robot speed in meters per second.
- maxSpeed - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The maximum achievable speed of the modules, used to adjust the size of the vectors.
- measuredChassisSpeeds - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The maximum achievable angular velocity of the robot.
- measuredStates - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
An array of rotation and velocity values describing the measured state of each swerve module
- min - Variable in class swervelib.parser.deserializer.PIDFRange
-
Minimum value.
- moduleCount - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Number of modules on the robot.
- moduleCount - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The number of swerve modules
- moduleFeedForwardClosedLoop - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that your drive train does not drift towards the direction you are rotating while you translate.
- ModuleJson - Class in swervelib.parser.json
-
SwerveModuleJSON parsed class. - ModuleJson() - Constructor for class swervelib.parser.json.ModuleJson
- moduleJsons - Static variable in class swervelib.parser.SwerveParser
-
Array holding the module jsons given in
SwerveDriveJson. - moduleLocation - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Swerve module location relative to the robot.
- moduleLocationsMeters - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Swerve Module locations.
- moduleNumber - Variable in class swervelib.SwerveModule
-
Module number for kinematics, usually 0 to 3.
- modules - Variable in class swervelib.parser.json.SwerveDriveJson
-
Module JSONs in order clockwise order starting from front left.
- modules - Variable in class swervelib.parser.SwerveDriveConfiguration
-
Swerve Modules.
- moduleStateOptimization - Variable in class swervelib.SwerveModule
-
Enable
SwerveModuleState2optimizations so the angle is reversed and speed is reversed to ensure the module never turns more than 90deg. - moduleSteerFFCL - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Angle volt-meter-per-second.
- moduleSteerFFCL - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Angle motor kV used for second order kinematics to tune the feedforward, this variable should be adjusted so that your drive train does not drift towards the direction you are rotating while you translate.
- motor - Variable in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
SparkMAX Instance.
- motor - Variable in class swervelib.motors.SparkMaxSwerve
-
SparkMAX Instance.
N
- name - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Name for the swerve module for telemetry.
- NavXSwerve - Class in swervelib.imu
-
Communicates with the NavX as the IMU.
- NavXSwerve(SerialPort.Port) - Constructor for class swervelib.imu.NavXSwerve
-
Constructor for the NavX swerve.
- NONE - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
No telemetry data is sent back.
- normalizeAngle(double) - Static method in class swervelib.math.SwerveMath
-
Normalize an angle to be within 0 to 360.
O
- omegaRadPerSecond - Variable in class swervelib.math.SwerveModuleState2
-
Rad per sec
- optimalVoltage - Variable in class swervelib.parser.json.SwerveDriveJson
-
Optimal voltage to compensate to and base feedforward calculations off of.
- optimalVoltage - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Optimal voltage of the robot.
- optimize(SwerveModuleState2, Rotation2d, SwerveModuleState2, double) - Static method in class swervelib.math.SwerveModuleState2
-
Minimize the change in heading the desired swerve module state would require by potentially reversing the direction the wheel spins.
- output - Variable in class swervelib.parser.PIDFConfig
-
The PIDF output range.
P
- p - Variable in class swervelib.parser.PIDFConfig
-
Proportional Gain for PID.
- physicalCharacteristics - Variable in class swervelib.parser.SwerveModuleConfiguration
-
Physical characteristics of the swerve module.
- physicalPropertiesJson - Static variable in class swervelib.parser.SwerveParser
-
Parsed modules/physicalproperties.json
- PhysicalPropertiesJson - Class in swervelib.parser.json
-
SwerveModulePhysicalCharacteristicsparsed data. - PhysicalPropertiesJson() - Constructor for class swervelib.parser.json.PhysicalPropertiesJson
- PhysicsSim - Class in swervelib.simulation.ctre
-
Manages physics simulation for CTRE products.
- PhysicsSim() - Constructor for class swervelib.simulation.ctre.PhysicsSim
- pid - Variable in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Closed-loop PID controller.
- pid - Variable in class swervelib.motors.SparkMaxSwerve
-
Closed-loop PID controller.
- PIDFConfig - Class in swervelib.parser
-
Hold the PIDF and Integral Zone values for a PID.
- PIDFConfig() - Constructor for class swervelib.parser.PIDFConfig
-
Used when parsing PIDF values from JSON.
- PIDFConfig(double, double) - Constructor for class swervelib.parser.PIDFConfig
-
PIDF Config constructor to contain the values.
- PIDFConfig(double, double, double) - Constructor for class swervelib.parser.PIDFConfig
-
PIDF Config constructor to contain the values.
- PIDFConfig(double, double, double, double) - Constructor for class swervelib.parser.PIDFConfig
-
PIDF Config constructor to contain the values.
- PIDFConfig(double, double, double, double, double) - Constructor for class swervelib.parser.PIDFConfig
-
PIDF Config constructor to contain the values.
- pidfPropertiesJson - Static variable in class swervelib.parser.SwerveParser
-
Parsed modules/pidfproperties.json
- PIDFPropertiesJson - Class in swervelib.parser.json
-
SwerveModulePID with Feedforward for the drive motor and angle motor. - PIDFPropertiesJson() - Constructor for class swervelib.parser.json.PIDFPropertiesJson
- PIDFRange - Class in swervelib.parser.deserializer
-
Class to hold the minimum and maximum input or output of the PIDF.
- PIDFRange() - Constructor for class swervelib.parser.deserializer.PIDFRange
- Pigeon2Swerve - Class in swervelib.imu
-
SwerveIMU interface for the Pigeon2
- Pigeon2Swerve(int) - Constructor for class swervelib.imu.Pigeon2Swerve
-
Generate the SwerveIMU for pigeon.
- Pigeon2Swerve(int, String) - Constructor for class swervelib.imu.Pigeon2Swerve
-
Generate the SwerveIMU for pigeon.
- PigeonSwerve - Class in swervelib.imu
-
SwerveIMU interface for the Pigeon.
- PigeonSwerve(int) - Constructor for class swervelib.imu.PigeonSwerve
-
Generate the SwerveIMU for pigeon.
- placeInAppropriate0To360Scope(double, double) - Static method in class swervelib.math.SwerveMath
-
Put an angle within the 360 deg scope of a reference.
- PoseLog(Pose2d) - Static method in class swervelib.math.SwerveMath
-
Logical inverse of the Pose exponential from 254.
- position - Variable in class swervelib.math.Matter
-
Position in meters from robot center in 3d space.
- postTrajectory(Trajectory) - Method in class swervelib.SwerveDrive
-
Post the trajectory to the field
Q
- queueSynchronizeEncoders() - Method in class swervelib.SwerveModule
-
Queue synchronization of the integrated angle encoder with the absolute encoder.
R
- rampRate - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
The minimum number of seconds to take for the motor to go from 0 to full throttle.
- readingError - Variable in class swervelib.encoders.SwerveAbsoluteEncoder
-
Last angle reading was faulty.
- replaceSwerveModuleFeedforward(SimpleMotorFeedforward) - Method in class swervelib.SwerveDrive
-
Setup the swerve module feedforward.
- resetEncoders() - Method in class swervelib.SwerveDrive
-
Reset the drive encoders on the robot, useful when manually resetting the robot without a reboot, like in autonomous.
- resetOdometry(Pose2d) - Method in class swervelib.SwerveDrive
-
Resets odometry to the given pose.
- resetPosition(Rotation2d, SwerveModulePosition[], Pose2d) - Method in class swervelib.math.SwerveDriveOdometry2
-
Resets the robot's position on the field.
- resetPosition(Rotation2d, SwerveModulePosition[], Pose2d) - Method in class swervelib.math.SwervePoseEstimator2
-
Resets the robot's position on the field.
- robotRotation - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The robot's current rotation based on odometry or gyro readings
- rotationUnit - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The units of the module rotations and robot rotation
- run() - Method in class swervelib.simulation.ctre.PhysicsSim
-
Runs the simulator: - enable the robot - simulate sensors
S
- set(double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the percentage output.
- set(double) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the percentage output.
- set(double) - Method in class swervelib.motors.SwerveMotor
-
Set the percentage output.
- set(double) - Method in class swervelib.motors.TalonFXSwerve
-
Set the percentage output.
- set(double) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the percentage output.
- setAbsoluteEncoder(SwerveAbsoluteEncoder) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the absolute encoder to be a compatible absolute encoder.
- setAbsoluteEncoder(SwerveAbsoluteEncoder) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the absolute encoder to be a compatible absolute encoder.
- setAbsoluteEncoder(SwerveAbsoluteEncoder) - Method in class swervelib.motors.SwerveMotor
-
Set the absolute encoder to be a compatible absolute encoder.
- setAbsoluteEncoder(SwerveAbsoluteEncoder) - Method in class swervelib.motors.TalonFXSwerve
-
Set the absolute encoder to be a compatible absolute encoder.
- setAbsoluteEncoder(SwerveAbsoluteEncoder) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the absolute encoder to be a compatible absolute encoder.
- setAngle(double) - Method in class swervelib.simulation.SwerveIMUSimulation
-
Set the heading of the robot.
- setAngle(double) - Method in class swervelib.SwerveModule
-
Set the angle for the module.
- setChassisSpeeds(ChassisSpeeds) - Method in class swervelib.SwerveDrive
-
Set chassis speeds with closed-loop velocity control and second order kinematics.
- setCurrentLimit(int) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with voltage compensation.
- setCurrentLimit(int) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with voltage compensation.
- setCurrentLimit(int) - Method in class swervelib.motors.SwerveMotor
-
Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with voltage compensation.
- setCurrentLimit(int) - Method in class swervelib.motors.TalonFXSwerve
-
Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with voltage compensation.
- setCurrentLimit(int) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the current limit for the swerve drive motor, remember this may cause jumping if used in conjunction with voltage compensation.
- setDesiredState(SwerveModuleState2, boolean, boolean) - Method in class swervelib.SwerveModule
-
Set the desired state of the swerve module.
- setGyro(Rotation3d) - Method in class swervelib.SwerveDrive
-
Set the expected gyroscope angle using a
Rotation3dobject. - setGyroOffset(Rotation3d) - Method in class swervelib.SwerveDrive
-
Set the gyro scope offset to a desired known rotation.
- setInverted(boolean) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the motor to be inverted.
- setInverted(boolean) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the motor to be inverted.
- setInverted(boolean) - Method in class swervelib.motors.SwerveMotor
-
Set the motor to be inverted.
- setInverted(boolean) - Method in class swervelib.motors.TalonFXSwerve
-
Set the motor to be inverted.
- setInverted(boolean) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the motor to be inverted.
- setLoopRampRate(double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the maximum rate the open/closed loop output can change by.
- setLoopRampRate(double) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the maximum rate the open/closed loop output can change by.
- setLoopRampRate(double) - Method in class swervelib.motors.SwerveMotor
-
Set the maximum rate the open/closed loop output can change by.
- setLoopRampRate(double) - Method in class swervelib.motors.TalonFXSwerve
-
Set the maximum rate the open/closed loop output can change by.
- setLoopRampRate(double) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the maximum rate the open/closed loop output can change by.
- setMaximumAngularVelocity(double) - Method in class swervelib.SwerveController
-
Set a new maximum angular velocity that is different from the auto-generated one.
- setMaximumSpeed(double) - Method in class swervelib.SwerveDrive
-
Set the maximum speed of the drive motors, modified
SwerveControllerConfiguration.maxSpeedandSwerveDriveConfiguration.maxSpeedwhich is used for theSwerveDrive.setRawModuleStates(SwerveModuleState2[], boolean)function andSwerveController.getTargetSpeeds(double, double, double, double, double)functions. - setMaximumSpeed(double, boolean) - Method in class swervelib.SwerveDrive
-
Set the maximum speed of the drive motors, modified
SwerveControllerConfiguration.maxSpeedandSwerveDriveConfiguration.maxSpeedwhich is used for theSwerveDrive.setRawModuleStates(SwerveModuleState2[], boolean)function andSwerveController.getTargetSpeeds(double, double, double, double, double)functions. - setMaximumSpeeds(double, double, double) - Method in class swervelib.SwerveDrive
-
Set the maximum speeds for desaturation.
- setModuleStateOptimization(boolean) - Method in class swervelib.SwerveDrive
-
Configure whether the
SwerveModuleState2will be optimized to prevent spinning more than 90deg. - setModuleStates(SwerveModuleState2[], boolean) - Method in class swervelib.SwerveDrive
-
Set the module states (azimuth and velocity) directly.
- setMotorBrake(boolean) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the idle mode.
- setMotorBrake(boolean) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the idle mode.
- setMotorBrake(boolean) - Method in class swervelib.motors.SwerveMotor
-
Set the idle mode.
- setMotorBrake(boolean) - Method in class swervelib.motors.TalonFXSwerve
-
Set the idle mode.
- setMotorBrake(boolean) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the idle mode.
- setMotorBrake(boolean) - Method in class swervelib.SwerveModule
-
Set the brake mode.
- setMotorIdleMode(boolean) - Method in class swervelib.SwerveDrive
-
Sets the drive motors to brake/coast mode.
- setOffset(Rotation3d) - Method in class swervelib.imu.ADIS16448Swerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.ADIS16470Swerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.ADXRS450Swerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.AnalogGyroSwerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.NavXSwerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.Pigeon2Swerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.PigeonSwerve
-
Set the gyro offset.
- setOffset(Rotation3d) - Method in class swervelib.imu.SwerveIMU
-
Set the gyro offset.
- setPosition(double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the integrated encoder position.
- setPosition(double) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the integrated encoder position.
- setPosition(double) - Method in class swervelib.motors.SwerveMotor
-
Set the integrated encoder position.
- setPosition(double) - Method in class swervelib.motors.TalonFXSwerve
-
Set the integrated encoder position.
- setPosition(double) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the integrated encoder position.
- setReference(double, double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double) - Method in class swervelib.motors.SwerveMotor
-
Set the closed loop PID controller reference point.
- setReference(double, double) - Method in class swervelib.motors.TalonFXSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double, double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double, double) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double, double) - Method in class swervelib.motors.SwerveMotor
-
Set the closed loop PID controller reference point.
- setReference(double, double, double) - Method in class swervelib.motors.TalonFXSwerve
-
Set the closed loop PID controller reference point.
- setReference(double, double, double) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the closed loop PID controller reference point.
- setVisionMeasurementStdDevs(Matrix<N3, N1>) - Method in class swervelib.math.SwervePoseEstimator2
-
Sets the pose estimator's trust of global measurements.
- setVoltageCompensation(double) - Method in class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Set the voltage compensation for the swerve module motor.
- setVoltageCompensation(double) - Method in class swervelib.motors.SparkMaxSwerve
-
Set the voltage compensation for the swerve module motor.
- setVoltageCompensation(double) - Method in class swervelib.motors.SwerveMotor
-
Set the voltage compensation for the swerve module motor.
- setVoltageCompensation(double) - Method in class swervelib.motors.TalonFXSwerve
-
Set the voltage compensation for the swerve module motor.
- setVoltageCompensation(double) - Method in class swervelib.motors.TalonSRXSwerve
-
Set the voltage compensation for the swerve module motor.
- sizeFrontBack - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The distance between the front and back modules.
- sizeLeftRight - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The distance between the left and right modules.
- SparkMaxBrushedMotorSwerve - Class in swervelib.motors
-
Brushed motor control with SparkMax.
- SparkMaxBrushedMotorSwerve(int, boolean, SparkMaxRelativeEncoder.Type, int, boolean) - Constructor for class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Initialize the
SwerveMotoras aCANSparkMaxconnected to a Brushless Motor. - SparkMaxBrushedMotorSwerve(CANSparkMax, boolean, SparkMaxRelativeEncoder.Type, int, boolean) - Constructor for class swervelib.motors.SparkMaxBrushedMotorSwerve
-
Initialize the swerve motor.
- SparkMaxEncoderSwerve - Class in swervelib.encoders
-
SparkMax absolute encoder, attached through the data port.
- SparkMaxEncoderSwerve(SwerveMotor, int) - Constructor for class swervelib.encoders.SparkMaxEncoderSwerve
-
Create the
AbsoluteEncoderobject as a duty cycle. - SparkMaxSwerve - Class in swervelib.motors
-
An implementation of
CANSparkMaxas aSwerveMotor. - SparkMaxSwerve(int, boolean) - Constructor for class swervelib.motors.SparkMaxSwerve
-
Initialize the
SwerveMotoras aCANSparkMaxconnected to a Brushless Motor. - SparkMaxSwerve(CANSparkMax, boolean) - Constructor for class swervelib.motors.SparkMaxSwerve
-
Initialize the swerve motor.
- stateStdDevs - Variable in class swervelib.SwerveDrive
-
Trustworthiness of the internal model of how motors should be moving Measured in expected standard deviation (meters of position and degrees of rotation)
- SwerveAbsoluteEncoder - Class in swervelib.encoders
-
Swerve abstraction class to define a standard interface with absolute encoders for swerve modules..
- SwerveAbsoluteEncoder() - Constructor for class swervelib.encoders.SwerveAbsoluteEncoder
- swerveController - Variable in class swervelib.SwerveDrive
-
Swerve controller for controlling heading of the robot.
- SwerveController - Class in swervelib
-
Controller class used to convert raw inputs into robot speeds.
- SwerveController(SwerveControllerConfiguration) - Constructor for class swervelib.SwerveController
-
Construct the SwerveController object which is used for determining the speeds of the robot based on controller input.
- SwerveControllerConfiguration - Class in swervelib.parser
-
Swerve Controller configuration class which is used to configure
SwerveController. - SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig) - Constructor for class swervelib.parser.SwerveControllerConfiguration
-
Construct the swerve controller configuration.
- SwerveControllerConfiguration(SwerveDriveConfiguration, PIDFConfig, double) - Constructor for class swervelib.parser.SwerveControllerConfiguration
-
Construct the swerve controller configuration.
- SwerveDrive - Class in swervelib
-
Swerve Drive class representing and controlling the swerve drive.
- SwerveDrive(SwerveDriveConfiguration, SwerveControllerConfiguration) - Constructor for class swervelib.SwerveDrive
-
Creates a new swerve drivebase subsystem.
- swerveDriveConfiguration - Variable in class swervelib.SwerveDrive
-
Swerve drive configuration.
- SwerveDriveConfiguration - Class in swervelib.parser
-
Swerve drive configurations used during SwerveDrive construction.
- SwerveDriveConfiguration(SwerveModuleConfiguration[], SwerveIMU, double, boolean) - Constructor for class swervelib.parser.SwerveDriveConfiguration
-
Create swerve drive configuration.
- swerveDriveJson - Static variable in class swervelib.parser.SwerveParser
-
Parsed swervedrive.json
- SwerveDriveJson - Class in swervelib.parser.json
-
SwerveDriveJSON parsed class. - SwerveDriveJson() - Constructor for class swervelib.parser.json.SwerveDriveJson
- SwerveDriveOdometry2 - Class in swervelib.math
-
Clone of
SwerveDriveOdometryexcept uses gyro pitch and roll to achieve a more accurate estimation. - SwerveDriveOdometry2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[]) - Constructor for class swervelib.math.SwerveDriveOdometry2
-
Constructs a SwerveDriveOdometry object with the default pose at the origin.
- SwerveDriveOdometry2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[], Pose2d) - Constructor for class swervelib.math.SwerveDriveOdometry2
-
Constructs a SwerveDriveOdometry object.
- swerveDrivePoseEstimator - Variable in class swervelib.SwerveDrive
-
Swerve odometry.
- SwerveDriveTelemetry - Class in swervelib.telemetry
-
Telemetry to describe the
SwerveDrivefollowing frc-web-components. - SwerveDriveTelemetry() - Constructor for class swervelib.telemetry.SwerveDriveTelemetry
- SwerveDriveTelemetry.TelemetryVerbosity - Enum Class in swervelib.telemetry
-
Verbosity of telemetry data sent back.
- SwerveIMU - Class in swervelib.imu
-
Swerve IMU abstraction to define a standard interface with a swerve drive.
- SwerveIMU() - Constructor for class swervelib.imu.SwerveIMU
- SwerveIMUSimulation - Class in swervelib.simulation
-
Simulation for
SwerveDriveIMU. - SwerveIMUSimulation() - Constructor for class swervelib.simulation.SwerveIMUSimulation
-
Create the swerve drive IMU simulation.
- SwerveKinematics2 - Class in swervelib.math
-
Clone of WPI SwerveKinematics, which implements second order kinematics when calculating modules states from chassis speed.
- SwerveKinematics2(Translation2d...) - Constructor for class swervelib.math.SwerveKinematics2
-
Constructs a swerve drive kinematics object.
- swervelib - package swervelib
-
Yet-Another Generic Swerve Library (YAGSL) main package AKA swervelib.
- swervelib.encoders - package swervelib.encoders
-
Absolute encoders for the swerve drive, all implement
SwerveAbsoluteEncoder. - swervelib.imu - package swervelib.imu
-
IMUs used for controlling the robot heading.
- swervelib.math - package swervelib.math
-
Mathematics for swerve drives.
- swervelib.motors - package swervelib.motors
-
Swerve motor controller wrappers which implement
SwerveMotor. - swervelib.parser - package swervelib.parser
-
JSON Parser for YAGSL configurations.
- swervelib.parser.deserializer - package swervelib.parser.deserializer
-
Deserialize specific variables for outside the parser.
- swervelib.parser.json - package swervelib.parser.json
-
JSON Mapped classes for parsing configuration files.
- swervelib.parser.json.modules - package swervelib.parser.json.modules
-
JSON Mapped Configuration types for modules.
- swervelib.simulation - package swervelib.simulation
-
Classes used to simulate the swerve drive.
- swervelib.simulation.ctre - package swervelib.simulation.ctre
-
CTRE Physics Simulator.
- swervelib.telemetry - package swervelib.telemetry
-
Telemetry package for sending data to NT4 or SmartDashboard.
- SwerveMath - Class in swervelib.math
-
Mathematical functions which pertain to swerve drive.
- SwerveMath() - Constructor for class swervelib.math.SwerveMath
- SwerveModule - Class in swervelib
-
The Swerve Module class which represents and controls Swerve Modules for the swerve drive.
- SwerveModule(int, SwerveModuleConfiguration) - Constructor for class swervelib.SwerveModule
-
Construct the swerve module and initialize the swerve module motors and absolute encoder.
- SwerveModuleConfiguration - Class in swervelib.parser
-
Swerve Module configuration class which is used to configure
SwerveModule. - SwerveModuleConfiguration(SwerveMotor, SwerveMotor, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, boolean, boolean, boolean, double, String) - Constructor for class swervelib.parser.SwerveModuleConfiguration
-
Construct a configuration object for swerve modules.
- SwerveModuleConfiguration(SwerveMotor, SwerveMotor, SwerveAbsoluteEncoder, double, double, double, PIDFConfig, PIDFConfig, double, SwerveModulePhysicalCharacteristics, String) - Constructor for class swervelib.parser.SwerveModuleConfiguration
-
Construct a configuration object for swerve modules.
- SwerveModulePhysicalCharacteristics - Class in swervelib.parser
-
Configuration class which stores physical characteristics shared between every swerve module.
- SwerveModulePhysicalCharacteristics(double, double, double, double, double, int, int) - Constructor for class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Construct the swerve module physical characteristics.
- SwerveModulePhysicalCharacteristics(double, double, double, double, double, int, int, double, double, int, int, double) - Constructor for class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Construct the swerve module physical characteristics.
- SwerveModuleSimulation - Class in swervelib.simulation
-
Class to hold simulation data for
SwerveModule - SwerveModuleSimulation() - Constructor for class swervelib.simulation.SwerveModuleSimulation
-
Create simulation class and initialize module at 0.
- SwerveModuleState2 - Class in swervelib.math
-
Second order kinematics swerve module state.
- SwerveModuleState2() - Constructor for class swervelib.math.SwerveModuleState2
-
Constructs a SwerveModuleState with zeros for speed and angle.
- SwerveModuleState2(double, Rotation2d, double) - Constructor for class swervelib.math.SwerveModuleState2
-
Constructs a SwerveModuleState.
- SwerveModuleState2(SwerveModuleState, double) - Constructor for class swervelib.math.SwerveModuleState2
-
Create a
SwerveModuleState2based on theSwerveModuleStatewith the radians per second defined. - SwerveMotor - Class in swervelib.motors
-
Swerve motor abstraction which defines a standard interface for motors within a swerve module.
- SwerveMotor() - Constructor for class swervelib.motors.SwerveMotor
- SwerveParser - Class in swervelib.parser
-
Helper class used to parse the JSON directory with specified configuration options.
- SwerveParser(File) - Constructor for class swervelib.parser.SwerveParser
-
Construct a swerve parser.
- SwervePoseEstimator2 - Class in swervelib.math
-
Clone of
SwerveDrivePoseEstimatorwhich takes into account gyroscope pitch and roll to achieve a more accurate estimation, originally made by Team 1466. - SwervePoseEstimator2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[], Pose2d) - Constructor for class swervelib.math.SwervePoseEstimator2
-
Constructs a SwerveDrivePoseEstimator with default standard deviations for the model and vision measurements.
- SwervePoseEstimator2(SwerveDriveKinematics, Rotation2d, SwerveModulePosition[], Pose2d, Matrix<N3, N1>, Matrix<N3, N1>) - Constructor for class swervelib.math.SwervePoseEstimator2
-
Constructs a SwerveDrivePoseEstimator.
- synchronizeModuleEncoders() - Method in class swervelib.SwerveDrive
-
Synchronize angle motor integrated encoders with data from absolute encoders.
T
- TalonFXSwerve - Class in swervelib.motors
-
TalonFXSwerve Motor. - TalonFXSwerve(int, boolean) - Constructor for class swervelib.motors.TalonFXSwerve
-
Construct the TalonFX swerve motor given the ID.
- TalonFXSwerve(int, String, boolean) - Constructor for class swervelib.motors.TalonFXSwerve
-
Construct the TalonFX swerve motor given the ID and CANBus.
- TalonFXSwerve(WPI_TalonFX, boolean) - Constructor for class swervelib.motors.TalonFXSwerve
-
Constructor for TalonFX swerve motor.
- TalonSRXSwerve - Class in swervelib.motors
-
WPI_TalonSRXSwerve Motor. - TalonSRXSwerve(int, boolean) - Constructor for class swervelib.motors.TalonSRXSwerve
-
Construct the TalonSRX swerve motor given the ID.
- TalonSRXSwerve(WPI_TalonSRX, boolean) - Constructor for class swervelib.motors.TalonSRXSwerve
-
Constructor for TalonSRX swerve motor.
- thetaController - Variable in class swervelib.SwerveController
-
PID Controller for the robot heading.
- toChassisSpeeds(SwerveModuleState2...) - Method in class swervelib.math.SwerveKinematics2
-
Performs forward kinematics to return the resulting chassis state from the given module states.
- toSwerveModuleState() - Method in class swervelib.math.SwerveModuleState2
-
Convert to a
SwerveModuleState. - toSwerveModuleStates(ChassisSpeeds) - Method in class swervelib.math.SwerveKinematics2
-
Performs inverse kinematics.
- toSwerveModuleStates(ChassisSpeeds, Translation2d) - Method in class swervelib.math.SwerveKinematics2
-
Performs inverse kinematics to return the module states from a desired chassis velocity.
- toTwist2d(SwerveModulePosition...) - Method in class swervelib.math.SwerveKinematics2
-
Performs forward kinematics to return the resulting chassis state from the given module states.
- type - Variable in class swervelib.parser.json.DeviceJson
-
The device type, e.g.
U
- update(Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[]) - Method in class swervelib.math.SwerveDriveOdometry2
-
Updates the robot's position on the field using forward kinematics and integration of the pose over time.
- update(Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[]) - Method in class swervelib.math.SwervePoseEstimator2
-
Updates the pose estimator with wheel encoder and gyro information.
- updateData() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
-
Upload data to smartdashboard
- updateOdometry() - Method in class swervelib.SwerveDrive
-
Update odometry should be run every loop.
- updateOdometry(SwerveKinematics2, SwerveModuleState2[], Pose2d[], Field2d) - Method in class swervelib.simulation.SwerveIMUSimulation
- updateStateAndPosition(SwerveModuleState2) - Method in class swervelib.simulation.SwerveModuleSimulation
-
Update the position and state of the module.
- updateWithTime(double, Rotation2d, Rotation2d, Rotation2d, SwerveModulePosition[]) - Method in class swervelib.math.SwervePoseEstimator2
-
Updates the pose estimator with wheel encoder and gyro information.
V
- valueOf(String) - Static method in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- velocityPIDF - Variable in class swervelib.parser.SwerveModuleConfiguration
-
PIDF configuration options for the drive motor closed-loop PID controller.
- verbosity - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The current telemetry verbosity level.
- visionMeasurementStdDevs - Variable in class swervelib.SwerveDrive
-
Trustworthiness of the vision system Measured in expected standard deviation (meters of position and degrees of rotation)
W
- wheelDiameter - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
Wheel diameter in inches.
- wheelDiameter - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Wheel diameter in meters.
- wheelGripCoefficientOfFriction - Variable in class swervelib.parser.json.PhysicalPropertiesJson
-
The grip tape coefficient of friction on carpet.
- wheelGripCoefficientOfFriction - Variable in class swervelib.parser.SwerveModulePhysicalCharacteristics
-
Wheel grip tape coefficient of friction on carpet, as described by the vendor.
- wheelLocations - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
-
The number of swerve modules
- withinHypotDeadband(double, double) - Method in class swervelib.SwerveController
-
Calculate the hypot deadband and check if the joystick is within it.
X
- x - Variable in class swervelib.parser.json.modules.LocationJson
-
Location of the swerve module in inches from the center of the robot horizontally.
- xLimiter - Variable in class swervelib.SwerveController
-
SlewRateLimiterfor movement in the X direction in meters/second.
Y
- y - Variable in class swervelib.parser.json.modules.LocationJson
-
Location of the swerve module in inches from the center of the robot vertically.
- yLimiter - Variable in class swervelib.SwerveController
-
SlewRateLimiterfor movement in the Y direction in meters/second.
Z
- zeroGyro() - Method in class swervelib.SwerveDrive
-
Resets the gyro angle to zero and resets odometry to the same position, but facing toward 0.
All Classes and Interfaces|All Packages