Index
All Classes and Interfaces|All Packages
A
- a - Variable in class swervelib.core.parser.PIDFConfig
-
Feedforward kA property.
- absoluteEncoder - Variable in class swervelib.core.parser.json.ModuleJson
-
Absolute encoder device configuration.
- absoluteEncoder() - Method in record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Returns the value of the
absoluteEncoderrecord component. - absoluteEncoderGearRatio - Variable in class swervelib.core.parser.json.ModuleJson
-
Reduction ratio for the absolute encoder to the motor.
- absoluteEncoderInverted - Variable in class swervelib.core.parser.json.ModuleJson
-
Absolute encoder inversion state.
- absoluteEncoderOffset - Variable in class swervelib.core.parser.json.ModuleJson
-
Absolute encoder offset from 0 in degrees.
- ANALOG - Enum constant in enum class swervelib.core.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
-
Analog input
FeedbackSensor.kAnalogSensor - ANALOG - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
Analog encoder.
- ANALOG5V - Enum constant in enum class swervelib.core.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
-
Analog input
FeedbackSensor.kAnalogSensor - ANDYMARK - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
AM CAN Encoder
- ANDYMARK - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
AndyMark.
- ANDYMARKHEXBORE - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
AndyMark hex bore encoder, read as a duty cycle encoder.
- angle - Variable in class swervelib.core.parser.json.ModuleJson
-
Angle motor device configuration.
- angle - Variable in class swervelib.core.parser.json.modules.BoolMotorJson
-
Angle motor inversion state.
- angle - Variable in class swervelib.core.parser.json.modules.GearingJson
-
Angle motor conversion factors composition.
- angle - Variable in class swervelib.core.parser.json.MotorConfigDouble
-
Angle motor.
- angle - Variable in class swervelib.core.parser.json.MotorConfigInt
-
Angle motor.
- angle - Variable in class swervelib.core.parser.json.PIDFPropertiesJson
-
The PIDF with Integral Zone used for the angle motor.
- AngleGearingJson - Class in swervelib.core.parser.json.modules
-
Angle motor conversion factors composite JSON parse class.
- AngleGearingJson() - Constructor for class swervelib.core.parser.json.modules.AngleGearingJson
- azimuth() - Method in record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Returns the value of the
azimuthrecord component.
B
- BoolMotorJson - Class in swervelib.core.parser.json.modules
-
Inverted motor JSON parsed class.
- BoolMotorJson() - Constructor for class swervelib.core.parser.json.modules.BoolMotorJson
- buildSwerveDrive(SwerveDriveConfig, Supplier) - Static method in class swervelib.core.parser.SwerveParser
-
Build the
SwerveModules and gyro from the parsed JSON configuration and apply them to the givenSwerveDriveConfig, collecting the raw vendor hardware devices created along the way.
C
- Cache<T> - Class in swervelib.core.parser
-
Cache for frequently requested data.
- Cache(Supplier, long) - Constructor for class swervelib.core.parser.Cache
-
Cache for arbitrary values.
- CANANDGYRO - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.Gyro
-
CANandGyro
- CANANDMAG - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
Redux Canandmag encoder.
- CANANDMAG - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
CANandMag encoder
- canbus - Variable in class swervelib.core.parser.json.DeviceJson
-
The CAN bus the device is on if using CAN: empty for can_s0, or the bus number, such as
"1"for can_s1. - CANBuses - Class in swervelib.core.parser
-
Turns the
canbusof a device in the JSON configuration into a CAN bus, the same way for every vendor. - CANCODER - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
CANCoder class
- canIdWarning - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
An
Alertfor if the CAN ID is greater than 40. - channel - Variable in class swervelib.core.parser.json.DeviceJson
-
SmartIO Channel.
- create(ReflectionsManager.VENDOR, String, Class[], Object[]) - Static method in class swervelib.core.parser.deserializer.ReflectionsManager
-
Create objects if the vendordep exists.
- createSwerveDrive(SwerveDriveConfig) - Static method in class swervelib.commands2.SwerveParser
-
Create a
SwerveDrivefrom the parsed JSON configuration. - createSwerveDrive(SwerveDriveConfig) - Static method in class swervelib.commands3.SwerveParser
-
Create a
SwerveDrivefrom the parsed JSON configuration. - createSwerveDriveDevices(SwerveDriveConfig) - Static method in class swervelib.commands2.SwerveParser
-
Create a
SwerveDrivefrom the parsed JSON configuration, exposing the raw vendor hardware devices created along the way (drive/azimuth motor controllers, absolute encoders, and the gyro) alongside it. - createSwerveDriveDevices(SwerveDriveConfig) - Static method in class swervelib.commands3.SwerveParser
-
Create a
SwerveDrivefrom the parsed JSON configuration, exposing the raw vendor hardware devices created along the way (drive/azimuth motor controllers, absolute encoders, and the gyro) alongside it. - CTRE - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Cross The Road Electronics.
- CTREDevices - Class in swervelib.core.parser.deserializer.reflections
- CTREDevices() - Constructor for class swervelib.core.parser.deserializer.reflections.CTREDevices
- CTREDevices.MotorControllerType - Enum Class in swervelib.core.parser.deserializer.reflections
-
Motor controller types.
D
- d - Variable in class swervelib.core.parser.PIDFConfig
-
Derivative Gain for PID.
- DEFAULT - Static variable in class swervelib.core.parser.CANBuses
-
CAN bus used when a device leaves
canbusempty. - desiredChassisSpeeds - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Describes the desired forward, sideways and angular velocity of the robot.
- desiredChassisSpeedsObj - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Describes the desired forward, sideways and angular velocity of the robot.
- desiredStates - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
An array of rotation and velocity values describing the desired state of each swerve module
- desiredStatesObj - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Desired swerve module states object
- DeviceJson - Class in swervelib.core.parser.json
-
Device JSON parsed class.
- DeviceJson() - Constructor for class swervelib.core.parser.json.DeviceJson
- DeviceJson.VENDOR - Enum Class in swervelib.core.parser.json
-
Vendor of a device (motor controller, encoder, or gyroscope).
- diameter - Variable in class swervelib.core.parser.json.modules.DriveGearingJson
-
Diameter of the wheel in inches.
- drive - Variable in class swervelib.core.parser.json.ModuleJson
-
Drive motor device configuration.
- drive - Variable in class swervelib.core.parser.json.modules.BoolMotorJson
-
Drive motor inversion state.
- drive - Variable in class swervelib.core.parser.json.modules.GearingJson
-
Drive motor conversion factors composition.
- drive - Variable in class swervelib.core.parser.json.MotorConfigDouble
-
Drive motor.
- drive - Variable in class swervelib.core.parser.json.MotorConfigInt
-
Drive motor.
- drive - Variable in class swervelib.core.parser.json.PIDFPropertiesJson
-
The PIDF with Integral Zone used for the drive motor.
- drive() - Method in record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Returns the value of the
driverecord component. - DriveGearingJson - Class in swervelib.core.parser.json.modules
-
Drive motor composite JSON parse class.
- DriveGearingJson() - Constructor for class swervelib.core.parser.json.modules.DriveGearingJson
- DUTYCYCLE - Enum constant in enum class swervelib.core.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
-
Duty cycle
FeedbackSensor.kAbsoluteEncoder - DUTYCYCLE - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
DutyCycle encoder.
E
- encoder - Variable in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
Absolute encoder type.
- endCtrlCycle() - Static method in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Update the Control cycle time.
- endOdomCycle() - Static method in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Update the odom cycle time.
- equals(Object) - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveHardware
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Indicates whether some other object is "equal to" this one.
- equals(DriveGearingJson) - Method in class swervelib.core.parser.json.modules.AngleGearingJson
-
Compare the gear ratio of this object to another.
- equals(DriveGearingJson) - Method in class swervelib.core.parser.json.modules.DriveGearingJson
-
Compare the gear ratio and wheel diameter of this object to another.
- exists() - Method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
Check if the vendordep exists.
F
- forwardDirection - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The direction the robot should be facing when the "Robot Rotation" is zero or blank.
- front - Variable in class swervelib.core.parser.json.modules.LocationJson
-
Location of the swerve module in
Units.Inchesfrom the center of the robot horizontally.
G
- gearing - Variable in class swervelib.core.parser.json.ModuleJson
-
Conversion Factors composition.
- gearing - Variable in class swervelib.core.parser.json.PhysicalPropertiesJson
-
Conversion Factors composition.
- GearingJson - Class in swervelib.core.parser.json.modules
-
Conversion Factors parsed JSON class
- GearingJson() - Constructor for class swervelib.core.parser.json.modules.GearingJson
- gearRatio - Variable in class swervelib.core.parser.json.modules.AngleGearingJson
-
Reduction ratio for the motor to the wheel.
- gearRatio - Variable in class swervelib.core.parser.json.modules.DriveGearingJson
-
Reduction ratio for the motor to the wheel.
- getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.core.parser.deserializer.reflections.CTREDevices
-
Get the
CANcoderangle. - getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.core.parser.deserializer.reflections.ReduxDevices
-
Get the
Canandmagangle. - getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.core.parser.deserializer.reflections.REVDevices
-
Get the
AngleSupplierand the encoder object. - getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices
-
Get the Thrifty CAN Encoder angle.
- getAbsoluteEncoder(int, String, boolean) - Method in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
Get the
Angleas aSupplierand the vendor absolute encoder object. - getAbsoluteEncoder(String, SmartMotorController, boolean) - Method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
Get the
Angleas aSupplierand the vendor absolute encoder object. - getAbsoluteEncoder(ReflectionsManager.VendorMotorController, SmartMotorController, boolean) - Method in class swervelib.core.parser.json.DeviceJson
-
Get the Absolute Encoder Supplier and Vendor Absolute Encoder Object.
- getAttachedAbsoluteEncoder(String, Object, boolean) - Static method in class swervelib.core.parser.deserializer.reflections.REVDevices
-
Get the attached absolute encoder.
- getAttachedAbsoluteEncoder(String, Object, boolean) - Static method in class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices
-
Get the absolute encoder attached to the
Nova's data port. - getCANPort(String) - Static method in class swervelib.core.parser.CANBuses
-
Get the
CANPortfor thecanbusof a device. - getDCMotor(String) - Static method in class swervelib.core.parser.json.DeviceJson
-
Get the DC motor from the motor type.
- getGyro() - Method in class swervelib.core.parser.json.DeviceJson
-
Get the gyro attitude supplier.
- getGyro(int, String) - Static method in class swervelib.core.parser.deserializer.reflections.CTREDevices
-
Get the gyroscope attitude supplier and gyroscope object.
- getGyro(int, String) - Static method in class swervelib.core.parser.deserializer.reflections.ReduxDevices
-
Get the gyroscope attitude supplier and gyroscope object.
- getGyro(int, String) - Static method in class swervelib.core.parser.deserializer.reflections.StudicaLibDevices
-
Get the gyroscope attitude supplier and gyroscope object.
- getGyro(int, String) - Method in enum class swervelib.core.parser.deserializer.ReflectionsManager.Gyro
-
Get the gyroscope's attitude as a
SupplierofRotation3dand the vendor gyroscope object. - getMotorController() - Method in class swervelib.core.parser.json.DeviceJson
-
Get the
ReflectionsManager.VendorMotorControllerobject for the device. - getMotorController(int, String, SmartMotorControllerConfig, DCMotor) - Method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
Get the
CTREDevices.MotorControllerTypeas aSmartMotorController. - getMotorController(int, String, SmartMotorControllerConfig, DCMotor, String) - Static method in class swervelib.core.parser.deserializer.reflections.CTREDevices
-
Get the
CTREDevices.MotorControllerTypeas aSmartMotorController. - getMotorController(int, String, SmartMotorControllerConfig, DCMotor, String) - Static method in class swervelib.core.parser.deserializer.reflections.REVDevices
-
Get the
SparkBaseas aSmartMotorController. - getMotorController(int, String, SmartMotorControllerConfig, DCMotor, String) - Static method in class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices
-
Get the
Novaas aSmartMotorController. - getSmartMotorController(SmartMotorControllerConfig) - Method in class swervelib.core.parser.json.DeviceJson
- getValue() - Method in class swervelib.core.parser.Cache
-
Get the most up to date cached value.
- getVendor(DeviceJson.VENDOR) - Method in class swervelib.core.parser.json.DeviceJson
-
Get the vendor of the device.
- gyro - Variable in class swervelib.core.parser.json.SwerveDriveJson
-
Robot Gyroscope used to determine the heading of the robot.
- gyro() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Returns the value of the
gyrorecord component. - gyro() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveHardware
-
Returns the value of the
gyrorecord component. - gyroAxis - Variable in class swervelib.core.parser.json.SwerveDriveJson
-
Gyro axis that points up through the robot, one of
yaw,pitch, orroll. - gyroInvert - Variable in class swervelib.core.parser.json.SwerveDriveJson
-
Invert the Gyroscope heading of the robot.
H
- hashCode() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Returns a hash code value for this object.
- hashCode() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveHardware
-
Returns a hash code value for this object.
- hashCode() - Method in record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Returns a hash code value for this object.
- HIGH - Enum constant in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Full swerve drive data is sent back in both human and machine readable forms.
I
- i - Variable in class swervelib.core.parser.PIDFConfig
-
Integral Gain for PID.
- i2cLockupWarning - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
An
Alertfor if there is an I2C lockup issue on the roboRIO. - id - Variable in class swervelib.core.parser.json.DeviceJson
-
The CAN ID or pin ID of the device.
- INFO - Enum constant in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Medium telemetry data, swerve directory
- inverted - Variable in class swervelib.core.parser.json.ModuleJson
-
Defines which motors are inverted.
- isSimulation - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
State of simulation of the Robot, used to optimize retrieval.
- isStale() - Method in class swervelib.core.parser.Cache
-
Return whether the cache is stale.
L
- left - Variable in class swervelib.core.parser.json.modules.LocationJson
-
Location of the swerve module in
Units.Inchesfrom the center of the robot vertically. - LIMELIGHT - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Limelight.
- location - Variable in class swervelib.core.parser.json.ModuleJson
-
The location of the swerve module from the center of the robot in inches.
- LocationJson - Class in swervelib.core.parser.json.modules
-
Location JSON parsed class.
- LocationJson() - Constructor for class swervelib.core.parser.json.modules.LocationJson
- LOW - Enum constant in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Low telemetry data, only post the robot position on the field.
M
- MACHINE - Enum constant in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Only send the machine readable data related to swerve drive.
- maxAngularVelocity - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The maximum achievable angular velocity of the robot.
- maxSpeed - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The maximum achievable speed of the modules, used to adjust the size of the vectors.
- measuredChassisSpeeds - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The maximum achievable angular velocity of the robot.
- measuredChassisSpeedsObj - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The maximum achievable angular velocity of the robot.
- measuredStates - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
An array of rotation and velocity values describing the measured state of each swerve module
- measuredStatesObj - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Measured swerve module states object.
- moduleCount - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The number of swerve modules
- ModuleJson - Class in swervelib.core.parser.json
-
SwerveModuleJSON parsed class. - ModuleJson() - Constructor for class swervelib.core.parser.json.ModuleJson
- moduleJsons - Static variable in class swervelib.core.parser.SwerveParser
-
Array holding the module jsons given in
SwerveDriveJson. - modules - Variable in class swervelib.core.parser.json.SwerveDriveJson
-
Module JSONs in order clockwise order starting from front left.
- modules() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Returns the value of the
modulesrecord component. - modules() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveHardware
-
Returns the value of the
modulesrecord component. - MotorConfigDouble - Class in swervelib.core.parser.json
-
Used to store doubles for motor configuration.
- MotorConfigDouble() - Constructor for class swervelib.core.parser.json.MotorConfigDouble
-
Default constructor.
- MotorConfigDouble(double, double) - Constructor for class swervelib.core.parser.json.MotorConfigDouble
-
Default constructor.
- MotorConfigInt - Class in swervelib.core.parser.json
-
Used to store ints for motor configuration.
- MotorConfigInt() - Constructor for class swervelib.core.parser.json.MotorConfigInt
-
Default constructor.
- MotorConfigInt(int, int) - Constructor for class swervelib.core.parser.json.MotorConfigInt
-
Default constructor with values.
N
- NAVX3 - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.Gyro
-
NavX3 Gyro
- NONE - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
not a motor controller
- NONE - Enum constant in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
No telemetry data is sent back.
- NOVA - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.MotorControllerType
-
Nova - NOVA - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
ThriftyBot Nova Motor Controller
P
- p - Variable in class swervelib.core.parser.PIDFConfig
-
Proportional Gain for PID.
- parse(File) - Static method in class swervelib.core.parser.SwerveParser
-
Parses a swerve configuration directory and creates a
SwerveParsercontaining the parsed configuration. - parseDirectory(File) - Static method in class swervelib.core.parser.SwerveParser
- PHOENIX5 - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
CTRE Phoenix 5 and 6
- PHOENIX6 - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
CTRE Phoenix 6
- physicalPropertiesJson - Static variable in class swervelib.core.parser.SwerveParser
-
Parsed modules/physicalproperties.json
- PhysicalPropertiesJson - Class in swervelib.core.parser.json
-
Used to configure the SwerveModule.
- PhysicalPropertiesJson() - Constructor for class swervelib.core.parser.json.PhysicalPropertiesJson
- PIDFConfig - Class in swervelib.core.parser
-
Hold the PIDF and Integral Zone values for a PID.
- PIDFConfig() - Constructor for class swervelib.core.parser.PIDFConfig
- pidfPropertiesJson - Static variable in class swervelib.core.parser.SwerveParser
-
Parsed modules/pidfproperties.json
- PIDFPropertiesJson - Class in swervelib.core.parser.json
-
SwerveModulePID with Feedforward for the drive motor and angle motor. - PIDFPropertiesJson() - Constructor for class swervelib.core.parser.json.PIDFPropertiesJson
- PIGEON2 - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.Gyro
-
Pigeon2 Gyro
- POSE - Enum constant in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Info level + field info
R
- readJson(File, Class) - Static method in class swervelib.core.parser.SwerveParser
-
Read a JSON file into the given type with WPILib's JSON library (avaje-jsonb).
- REDUX - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Redux Robotics.
- ReduxDevices - Class in swervelib.core.parser.deserializer.reflections
-
Reflective class for
Canandgyroand other devices. - ReduxDevices() - Constructor for class swervelib.core.parser.deserializer.reflections.ReduxDevices
- ReflectionsManager - Class in swervelib.core.parser.deserializer
-
Create classes only if the vendor dep exists.
- ReflectionsManager() - Constructor for class swervelib.core.parser.deserializer.ReflectionsManager
- ReflectionsManager.AbsoluteEncoder - Enum Class in swervelib.core.parser.deserializer
-
Absolute encoder vendor classes.
- ReflectionsManager.Gyro - Enum Class in swervelib.core.parser.deserializer
-
Gyro vendor classes.
- ReflectionsManager.VENDOR - Enum Class in swervelib.core.parser.deserializer
-
Vendors that supply their own vendordep to communicate with their products.
- ReflectionsManager.VendorMotorController - Enum Class in swervelib.core.parser.deserializer
-
SmartMotorControllervendor classes. - requireCANPort(String, String) - Static method in class swervelib.core.parser.CANBuses
-
Get the
CANPortfor thecanbusof a device from a vendor that only uses the Systemcore and Motioncore CAN buses. - REV - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
REVLib
- REV - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
REV Robotics.
- REVDevices - Class in swervelib.core.parser.deserializer.reflections
-
Reflection class for
SparkBases and other REV devices. - REVDevices() - Constructor for class swervelib.core.parser.deserializer.reflections.REVDevices
- REVDevices.AbsoluteEncoder - Enum Class in swervelib.core.parser.deserializer.reflections
-
Absolute encoder types.
- REVDevices.MotorControllerType - Enum Class in swervelib.core.parser.deserializer.reflections
-
Motor controller types.
- REVTHROUGHBORE - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
REV Through Bore encoder.
- robotRotation - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The robot's current rotation based on odometry or gyro readings
- robotRotationObj - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The robot's current rotation based on odometry or gyro readings
- rotationUnit - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The units of the module rotations and robot rotation
S
- s - Variable in class swervelib.core.parser.PIDFConfig
-
Feed forward kS property.
- serialCommsIssueWarning - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
NavX serial comm issue.
- sizeFrontBack - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The distance between the front and back modules.
- sizeLeftRight - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The distance between the left and right modules.
- SMARTIO - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Device attached to the roboRIO SmartIO port (DIO/Analog).
- SPARKFLEX - Enum constant in enum class swervelib.core.parser.deserializer.reflections.REVDevices.MotorControllerType
- SPARKFLEX - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
SparkFlex Motor Controller
- SPARKMAX - Enum constant in enum class swervelib.core.parser.deserializer.reflections.REVDevices.MotorControllerType
- SPARKMAX - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
SparkMax Motor Controller
- SPLINE_ENCODER - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
REV Robotics Spline Encoder, (if you use this for an azimuth encoder...
- SPLINEENCODER - Enum constant in enum class swervelib.core.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
- SRXMAG - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
SRX Mag encoder.
- startCtrlCycle() - Static method in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Start the ctrl timer to measure cycle time, independent of periodic loops.
- startOdomCycle() - Static method in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Start the odom cycle timer to calculate how long each odom took.
- statorCurrentLimit - Variable in class swervelib.core.parser.json.PhysicalPropertiesJson
-
The current limit in AMPs to apply to the motors.
- STUDICA - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
Studica
- STUDICA - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Studica.
- StudicaLibDevices - Class in swervelib.core.parser.deserializer.reflections
-
StudicaLib Gyroscope and other devices.
- StudicaLibDevices() - Constructor for class swervelib.core.parser.deserializer.reflections.StudicaLibDevices
- swerveDrive() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Returns the value of the
swerveDriverecord component. - SwerveDriveDevices(D, Object, SwerveParser.SwerveModuleDevices[]) - Constructor for record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Creates an instance of a
SwerveDriveDevicesrecord class. - SwerveDriveHardware(Object, SwerveParser.SwerveModuleDevices[]) - Constructor for record class swervelib.core.parser.SwerveParser.SwerveDriveHardware
-
Creates an instance of a
SwerveDriveHardwarerecord class. - swerveDriveJson - Static variable in class swervelib.core.parser.SwerveParser
-
Parsed swervedrive.json
- SwerveDriveJson - Class in swervelib.core.parser.json
-
SwerveDriveJSON parsed class. - SwerveDriveJson() - Constructor for class swervelib.core.parser.json.SwerveDriveJson
- SwerveDriveTelemetry - Class in swervelib.core.telemetry
-
Telemetry to describe the
SwerveDrivefollowing frc-web-components. - SwerveDriveTelemetry() - Constructor for class swervelib.core.telemetry.SwerveDriveTelemetry
- SwerveDriveTelemetry.TelemetryVerbosity - Enum Class in swervelib.core.telemetry
-
Verbosity of telemetry data sent back.
- swervelib.commands2 - package swervelib.commands2
-
YAGSL entry points for WPILib Commands v2.
- swervelib.commands3 - package swervelib.commands3
-
YAGSL entry points for WPILib Commands v3.
- swervelib.core.parser - package swervelib.core.parser
-
JSON Parser for YAGSL configurations.
- swervelib.core.parser.deserializer - package swervelib.core.parser.deserializer
-
Deserialize specific variables for outside the parser.
- swervelib.core.parser.deserializer.reflections - package swervelib.core.parser.deserializer.reflections
- swervelib.core.parser.json - package swervelib.core.parser.json
-
JSON Mapped classes for parsing configuration files.
- swervelib.core.parser.json.modules - package swervelib.core.parser.json.modules
-
JSON Mapped Configuration types for modules.
- swervelib.core.telemetry - package swervelib.core.telemetry
-
Telemetry package for sending data to NT4 or SmartDashboard.
- SwerveModuleDevices(Object, Object, Object) - Constructor for record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Creates an instance of a
SwerveModuleDevicesrecord class. - SwerveParser - Class in swervelib.commands2
-
SwerveParserfor WPILib Commands v2. - SwerveParser - Class in swervelib.commands3
-
SwerveParserfor WPILib Commands v3. - SwerveParser - Class in swervelib.core.parser
-
Helper class used to parse the JSON directory with specified configuration options.
- SwerveParser() - Constructor for class swervelib.commands2.SwerveParser
-
Construct a swerve parser.
- SwerveParser() - Constructor for class swervelib.commands3.SwerveParser
-
Construct a swerve parser.
- SwerveParser() - Constructor for class swervelib.core.parser.SwerveParser
-
Construct a swerve parser.
- SwerveParser.SwerveDriveDevices<D> - Record Class in swervelib.core.parser
-
Raw hardware devices created by a command-framework specific
SwerveParser#createSwerveDriveDevices, alongside theSwerveDriveit built. - SwerveParser.SwerveDriveHardware - Record Class in swervelib.core.parser
-
Raw hardware devices created by
SwerveParser.buildSwerveDrive(SwerveDriveConfig, Supplier). - SwerveParser.SwerveModuleDevices - Record Class in swervelib.core.parser
-
Raw hardware devices created for a single
SwerveModulebySwerveParser.
T
- TALONFX - Enum constant in enum class swervelib.core.parser.deserializer.reflections.CTREDevices.MotorControllerType
- TALONFX - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
TalonFX Motor Controller within the Falcon 500, KrakenX60, and KrakenX44
- TALONFXS - Enum constant in enum class swervelib.core.parser.deserializer.reflections.CTREDevices.MotorControllerType
- TALONFXS - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
TalonFXS Motor Controller
- THRIFTY - Enum constant in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
Thrifty 10 pin absolute encoder.
- THRIFTYBOT - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
ThriftyLib
- THRIFTYBOT - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
ThriftyBot.
- THRIFTYBOT10PIN - Enum constant in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
ThriftyBot CAN encoder
- ThriftyBotDevices - Class in swervelib.core.parser.deserializer.reflections
-
Reflection class for
SmartMotorControllers and other devices from ThriftyBot. - ThriftyBotDevices() - Constructor for class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices
- ThriftyBotDevices.AbsoluteEncoder - Enum Class in swervelib.core.parser.deserializer.reflections
-
Absolute encoder types on the
Nova's data port, named after the encoder in the JSON<encoder>_attachedtype. - ThriftyBotDevices.MotorControllerType - Enum Class in swervelib.core.parser.deserializer.reflections
-
Motor controller types.
- toString() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveDevices
-
Returns a string representation of this record class.
- toString() - Method in record class swervelib.core.parser.SwerveParser.SwerveDriveHardware
-
Returns a string representation of this record class.
- toString() - Method in record class swervelib.core.parser.SwerveParser.SwerveModuleDevices
-
Returns a string representation of this record class.
- type - Variable in class swervelib.core.parser.json.DeviceJson
-
The device type
U
- UNKNOWN - Enum constant in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Vendor could not be determined.
- update() - Method in class swervelib.core.parser.Cache
-
Update the cache value and timestamp.
- updateData() - Static method in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Upload data to smartdashboard
- updateSettings - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Update the telemetry settings that infrequently change.
- updateSupplier(Supplier) - Method in class swervelib.core.parser.Cache
-
Update the supplier to a new source.
- updateSwerveTelemetrySettings() - Static method in class swervelib.core.telemetry.SwerveDriveTelemetry
-
Update only the settings that infrequently or never change.
- updateValidityPeriod(long) - Method in class swervelib.core.parser.Cache
-
Update the validity period for the cached value, also updates the value.
V
- v - Variable in class swervelib.core.parser.PIDFConfig
-
Feedforward kV property
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.reflections.CTREDevices.MotorControllerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.reflections.REVDevices.MotorControllerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.MotorControllerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.Gyro
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class swervelib.core.parser.deserializer.reflections.CTREDevices.MotorControllerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.reflections.REVDevices.MotorControllerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.reflections.ThriftyBotDevices.MotorControllerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.AbsoluteEncoder
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.Gyro
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VENDOR
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.deserializer.ReflectionsManager.VendorMotorController
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.parser.json.DeviceJson.VENDOR
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class swervelib.core.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verbosity - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The current telemetry verbosity level.
W
- wheelLocations - Static variable in class swervelib.core.telemetry.SwerveDriveTelemetry
-
The Locations of the swerve drive wheels.
All Classes and Interfaces|All Packages