Index

A B C D E F G H I L M N P R S T U V W Y 
All Classes and Interfaces|All Packages

A

a - Variable in class swervelib.parser.PIDFConfig
Feedforward kA property.
absoluteEncoder - Variable in class swervelib.parser.json.ModuleJson
Absolute encoder device configuration.
absoluteEncoder() - Method in record class swervelib.parser.SwerveParser.SwerveModuleDevices
Returns the value of the absoluteEncoder record component.
absoluteEncoderGearRatio - Variable in class swervelib.parser.json.ModuleJson
Reduction ratio for the absolute encoder to the motor.
absoluteEncoderInverted - Variable in class swervelib.parser.json.ModuleJson
Absolute encoder inversion state.
absoluteEncoderOffset - Variable in class swervelib.parser.json.ModuleJson
Absolute encoder offset from 0 in degrees.
ANALOG - Enum constant in enum class swervelib.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
ANALOG5V - Enum constant in enum class swervelib.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
ANDYMARK - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
AM CAN Encoder
ANDYMARK - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
AndyMark.
AndymarkDevices - Class in swervelib.parser.deserializer.reflections
Andymark Devices
AndymarkDevices() - Constructor for class swervelib.parser.deserializer.reflections.AndymarkDevices
 
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.modules.GearingJson
Angle motor conversion factors composition.
angle - Variable in class swervelib.parser.json.MotorConfigDouble
Angle motor.
angle - Variable in class swervelib.parser.json.MotorConfigInt
Angle motor.
angle - Variable in class swervelib.parser.json.PIDFPropertiesJson
The PIDF with Integral Zone used for the angle motor.
AngleGearingJson - Class in swervelib.parser.json.modules
Angle motor conversion factors composite JSON parse class.
AngleGearingJson() - Constructor for class swervelib.parser.json.modules.AngleGearingJson
 
applyConfig(SmartMotorControllerConfig) - Method in class yams.motorcontrollers.local.NovaWrapper
 
azimuth() - Method in record class swervelib.parser.SwerveParser.SwerveModuleDevices
Returns the value of the azimuth record component.

B

BoolMotorJson - Class in swervelib.parser.json.modules
Inverted motor JSON parsed class.
BoolMotorJson() - Constructor for class swervelib.parser.json.modules.BoolMotorJson
 

C

Cache<T> - Class in swervelib.parser
Cache for frequently requested data.
Cache(Supplier<T>, long) - Constructor for class swervelib.parser.Cache
Cache for arbitrary values.
CANANDGYRO - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.Gyro
CANandGyro
CANANDMAG - Enum constant in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
Redux Canandmag encoder.
CANANDMAG - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
CANandMag encoder
canbus - Variable in class swervelib.parser.json.DeviceJson
The CAN bus name which the device resides on if using CAN.
CANCODER - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
CANCoder class
canIdWarning - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
An Alert for if the CAN ID is greater than 40.
channel - Variable in class swervelib.parser.json.DeviceJson
SmartIO Channel.
create(ReflectionsManager.VENDOR, String, Class<?>[], Object[]) - Static method in class swervelib.parser.deserializer.ReflectionsManager
Create objects if the vendordep exists.
createSwerveDrive(SwerveDriveConfig) - Static method in class swervelib.parser.SwerveParser
Create a SwerveDrive from the parsed JSON configuration.
createSwerveDriveDevices(SwerveDriveConfig) - Static method in class swervelib.parser.SwerveParser
Create a SwerveDrive from 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.parser.json.DeviceJson.VENDOR
Cross The Road Electronics.
CTREDevices - Class in swervelib.parser.deserializer.reflections
Reflection class for TalonFX and TalonFXSs and other devices from CTRE.
CTREDevices() - Constructor for class swervelib.parser.deserializer.reflections.CTREDevices
 
CTREDevices.MotorControllerType - Enum Class in swervelib.parser.deserializer.reflections
Motor controller types.

D

d - Variable in class swervelib.parser.PIDFConfig
Derivative Gain for PID.
desiredChassisSpeeds - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
Describes the desired forward, sideways and angular velocity of the robot.
desiredChassisSpeedsObj - 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
desiredStatesObj - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
Desired swerve module states object
DeviceJson - Class in swervelib.parser.json
Device JSON parsed class.
DeviceJson() - Constructor for class swervelib.parser.json.DeviceJson
 
DeviceJson.VENDOR - Enum Class in swervelib.parser.json
Vendor of a device (motor controller, encoder, or gyroscope).
diameter - Variable in class swervelib.parser.json.modules.DriveGearingJson
Diameter of the wheel in inches.
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.modules.GearingJson
Drive motor conversion factors composition.
drive - Variable in class swervelib.parser.json.MotorConfigDouble
Drive motor.
drive - Variable in class swervelib.parser.json.MotorConfigInt
Drive motor.
drive - Variable in class swervelib.parser.json.PIDFPropertiesJson
The PIDF with Integral Zone used for the drive motor.
drive() - Method in record class swervelib.parser.SwerveParser.SwerveModuleDevices
Returns the value of the drive record component.
DriveGearingJson - Class in swervelib.parser.json.modules
Drive motor composite JSON parse class.
DriveGearingJson() - Constructor for class swervelib.parser.json.modules.DriveGearingJson
 
DUTYCYCLE - Enum constant in enum class swervelib.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
DUTYCYCLE - Enum constant in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
DutyCycle encoder.

E

encoder - Variable in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
Absolute encoder type.
endCtrlCycle() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
Update the Control cycle time.
endOdomCycle() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
Update the odom cycle time.
equals(Object) - Method in record class swervelib.parser.SwerveParser.SwerveDriveDevices
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class swervelib.parser.SwerveParser.SwerveModuleDevices
Indicates whether some other object is "equal to" this one.
equals(DriveGearingJson) - Method in class swervelib.parser.json.modules.AngleGearingJson
Compare the gear ratio of this object to another.
equals(DriveGearingJson) - Method in class swervelib.parser.json.modules.DriveGearingJson
Compare the gear ratio and wheel diameter of this object to another.
exists() - Method in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
Check if the vendordep exists.

F

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 Units.Inches from the center of the robot horizontally.

G

gearing - Variable in class swervelib.parser.json.ModuleJson
Conversion Factors composition.
gearing - Variable in class swervelib.parser.json.PhysicalPropertiesJson
Conversion Factors composition.
GearingJson - Class in swervelib.parser.json.modules
Conversion Factors parsed JSON class
GearingJson() - Constructor for class swervelib.parser.json.modules.GearingJson
 
gearRatio - Variable in class swervelib.parser.json.modules.AngleGearingJson
Reduction ratio for the motor to the wheel.
gearRatio - Variable in class swervelib.parser.json.modules.DriveGearingJson
Reduction ratio for the motor to the wheel.
getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.parser.deserializer.reflections.AndymarkDevices
Get the AM_CAN_HexBoreEncoder angle.
getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.parser.deserializer.reflections.CTREDevices
Get the CANcoder angle.
getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.parser.deserializer.reflections.ReduxDevices
Get the Canandmag angle.
getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.parser.deserializer.reflections.REVDevices
Get the Angle Supplier and the encoder object.
getAbsoluteEncoder(int, String, boolean) - Static method in class swervelib.parser.deserializer.reflections.ThriftyBotDevices
Get the ThriftyEncoder angle.
getAbsoluteEncoder(int, String, boolean) - Method in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
Get the Angle as a Supplier and the vendor absolute encoder object.
getAbsoluteEncoder(String, SmartMotorController, boolean) - Method in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
Get the Angle as a Supplier and the vendor absolute encoder object.
getAbsoluteEncoder(ReflectionsManager.VendorMotorController, SmartMotorController, boolean) - Method in class swervelib.parser.json.DeviceJson
Get the Absolute Encoder Supplier and Vendor Absolute Encoder Object.
getAttachedAbsoluteEncoder(String, Object, boolean) - Static method in class swervelib.parser.deserializer.reflections.REVDevices
Get the attached absolute encoder.
getAttachedAbsoluteEncoder(String, Object, boolean) - Static method in class swervelib.parser.deserializer.reflections.ThriftyBotDevices
Get the attached absolute encoder.
getConfig() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getDCMotor() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getDCMotor(String) - Static method in class swervelib.parser.json.DeviceJson
Get the DC motor from the motor type.
getDutyCycle() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getExternalEncoderPosition() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getExternalEncoderVelocity() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getGyro(int, String, SwerveDriveJson.GyroAxis, boolean) - Method in enum class swervelib.parser.deserializer.ReflectionsManager.Gyro
Get the angle.
getGyro(SwerveDriveJson.GyroAxis, boolean) - Method in class swervelib.parser.json.DeviceJson
Get the gyro angle supplier.
getGyroAngle(int, String, SwerveDriveJson.GyroAxis, boolean) - Static method in class swervelib.parser.deserializer.reflections.CTREDevices
Get the gyroscope angle supplier and gyroscope object.
getGyroAngle(int, String, SwerveDriveJson.GyroAxis, boolean) - Static method in class swervelib.parser.deserializer.reflections.ReduxDevices
Get the gyroscope angle supplier and gyroscope object.
getGyroAngle(int, String, SwerveDriveJson.GyroAxis, boolean) - Static method in class swervelib.parser.deserializer.reflections.StudicaLibDevices
Get the gyroscope angle supplier and gyroscope object.
getMeasurementAcceleration() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMeasurementPosition() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMeasurementVelocity() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMechanismAcceleration() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMechanismPosition() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMechanismVelocity() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMotorController() - Method in class swervelib.parser.json.DeviceJson
Get the ReflectionsManager.VendorMotorController object for the device.
getMotorController() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getMotorController(int, String, SmartMotorControllerConfig, DCMotor) - Method in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
Get the CTREDevices.MotorControllerType as a SmartMotorController.
getMotorController(int, String, SmartMotorControllerConfig, DCMotor, String) - Static method in class swervelib.parser.deserializer.reflections.CTREDevices
Get the CTREDevices.MotorControllerType as a SmartMotorController.
getMotorController(int, String, SmartMotorControllerConfig, DCMotor, String) - Static method in class swervelib.parser.deserializer.reflections.REVDevices
Get the SparkBase as a SmartMotorController.
getMotorController(int, String, SmartMotorControllerConfig, DCMotor, String) - Static method in class swervelib.parser.deserializer.reflections.ThriftyBotDevices
Get the ThriftyNova as a SmartMotorController.
getMotorControllerConfig() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getRotorPosition() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getRotorVelocity() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getSmartMotorController(SmartMotorControllerConfig) - Method in class swervelib.parser.json.DeviceJson
Get the SmartMotorController from the DeviceJson when given the SmartMotorControllerConfig.
getStatorCurrent() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getSupplyCurrent() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getTemperature() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getUnsupportedTelemetryFields() - Method in class yams.motorcontrollers.local.NovaWrapper
 
getValue() - Method in class swervelib.parser.Cache
Get the most up to date cached value.
getVendor(DeviceJson.VENDOR) - Method in class swervelib.parser.json.DeviceJson
Get the vendor of the device.
getVoltage() - Method in class yams.motorcontrollers.local.NovaWrapper
 
gyro - Variable in class swervelib.parser.json.SwerveDriveJson
Robot Gyroscope used to determine the heading of the robot.
gyro() - Method in record class swervelib.parser.SwerveParser.SwerveDriveDevices
Returns the value of the gyro record component.
gyroAxis - Variable in class swervelib.parser.json.SwerveDriveJson
Gyro rotation axis used to determine what orientation the robots heading is.
gyroInvert - Variable in class swervelib.parser.json.SwerveDriveJson
Invert the Gyroscope heading of the robot.

H

hashCode() - Method in record class swervelib.parser.SwerveParser.SwerveDriveDevices
Returns a hash code value for this object.
hashCode() - Method in record class swervelib.parser.SwerveParser.SwerveModuleDevices
Returns a hash code value for this object.
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.
i2cLockupWarning - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
An Alert for if there is an I2C lockup issue on the roboRIO.
id - Variable in class swervelib.parser.json.DeviceJson
The CAN ID or pin ID of the device.
INFO - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
Medium telemetry data, swerve directory
inverted - Variable in class swervelib.parser.json.ModuleJson
Defines which motors are inverted.
isSimulation - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
State of simulation of the Robot, used to optimize retrieval.
isStale() - Method in class swervelib.parser.Cache
Return whether the cache is stale.

L

left - Variable in class swervelib.parser.json.modules.LocationJson
Location of the swerve module in Units.Inches from the center of the robot vertically.
LIMELIGHT - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
Limelight.
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
 
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.
maxAngularVelocity - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The maximum achievable angular velocity of the robot.
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.
measuredChassisSpeedsObj - 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
measuredStatesObj - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
Measured swerve module states object.
moduleCount - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The number of swerve modules
ModuleJson - Class in swervelib.parser.json
SwerveModule JSON 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.
modules - Variable in class swervelib.parser.json.SwerveDriveJson
Module JSONs in order clockwise order starting from front left.
modules() - Method in record class swervelib.parser.SwerveParser.SwerveDriveDevices
Returns the value of the modules record component.
MotorConfigDouble - Class in swervelib.parser.json
Used to store doubles for motor configuration.
MotorConfigDouble() - Constructor for class swervelib.parser.json.MotorConfigDouble
Default constructor.
MotorConfigDouble(double, double) - Constructor for class swervelib.parser.json.MotorConfigDouble
Default constructor.
MotorConfigInt - Class in swervelib.parser.json
Used to store ints for motor configuration.
MotorConfigInt() - Constructor for class swervelib.parser.json.MotorConfigInt
Default constructor.
MotorConfigInt(int, int) - Constructor for class swervelib.parser.json.MotorConfigInt
Default constructor with values.

N

NAVX3 - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.Gyro
NavX3 Gyro
NONE - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
not a motor controller
NONE - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
No telemetry data is sent back.
NOVA - Enum constant in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.MotorControllerType
ThriftyNova
NOVA - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
ThriftyBot Nova Motor Controller
NovaWrapper - Class in yams.motorcontrollers.local
Nova wrapper for SmartMotorController
NovaWrapper(ThriftyNova, DCMotor, SmartMotorControllerConfig) - Constructor for class yams.motorcontrollers.local.NovaWrapper
Construct the Nova Wrapper for the generic SmartMotorController.

P

p - Variable in class swervelib.parser.PIDFConfig
Proportional Gain for PID.
parse(File) - Static method in class swervelib.parser.SwerveParser
Parses a swerve configuration directory and creates a SwerveParser containing the parsed configuration.
parseDirectory(File) - Static method in class swervelib.parser.SwerveParser
 
PHOENIX5 - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
CTRE Phoenix 5 and 6
PHOENIX6 - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
CTRE Phoenix 6
physicalPropertiesJson - Static variable in class swervelib.parser.SwerveParser
Parsed modules/physicalproperties.json
PhysicalPropertiesJson - Class in swervelib.parser.json
Used to configure the SwerveModule.
PhysicalPropertiesJson() - Constructor for class swervelib.parser.json.PhysicalPropertiesJson
 
PIDFConfig - Class in swervelib.parser
Hold the PIDF and Integral Zone values for a PID.
PIDFConfig() - Constructor for class swervelib.parser.PIDFConfig
 
pidfPropertiesJson - Static variable in class swervelib.parser.SwerveParser
Parsed modules/pidfproperties.json
PIDFPropertiesJson - Class in swervelib.parser.json
SwerveModule PID with Feedforward for the drive motor and angle motor.
PIDFPropertiesJson() - Constructor for class swervelib.parser.json.PIDFPropertiesJson
 
PIGEON2 - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.Gyro
Pigeon2 Gyro
PITCH - Enum constant in enum class swervelib.parser.json.SwerveDriveJson.GyroAxis
Pitch axis (X)
POSE - Enum constant in enum class swervelib.telemetry.SwerveDriveTelemetry.TelemetryVerbosity
Info level + field info

R

REDUX - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
Redux Robotics.
ReduxDevices - Class in swervelib.parser.deserializer.reflections
Reflective class for Canandgyro and other devices.
ReduxDevices() - Constructor for class swervelib.parser.deserializer.reflections.ReduxDevices
 
ReflectionsManager - Class in swervelib.parser.deserializer
Create classes only if the vendor dep exists.
ReflectionsManager() - Constructor for class swervelib.parser.deserializer.ReflectionsManager
 
ReflectionsManager.AbsoluteEncoder - Enum Class in swervelib.parser.deserializer
Absolute encoder vendor classes.
ReflectionsManager.Gyro - Enum Class in swervelib.parser.deserializer
Gyro vendor classes.
ReflectionsManager.VENDOR - Enum Class in swervelib.parser.deserializer
Vendors that supply their own vendordep to communicate with their products.
ReflectionsManager.VendorMotorController - Enum Class in swervelib.parser.deserializer
SmartMotorController vendor classes.
REV - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
REVLib
REV - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
REV Robotics.
REVDevices - Class in swervelib.parser.deserializer.reflections
Reflection class for SparkBases and other REV devices.
REVDevices() - Constructor for class swervelib.parser.deserializer.reflections.REVDevices
 
REVDevices.AbsoluteEncoder - Enum Class in swervelib.parser.deserializer.reflections
Absolute encoder types.
REVDevices.MotorControllerType - Enum Class in swervelib.parser.deserializer.reflections
Motor controller types.
robotRotation - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The robot's current rotation based on odometry or gyro readings
robotRotationObj - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The robot's current rotation based on odometry or gyro readings
ROLL - Enum constant in enum class swervelib.parser.json.SwerveDriveJson.GyroAxis
Roll axis (Y)
rotationUnit - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The units of the module rotations and robot rotation

S

s - Variable in class swervelib.parser.PIDFConfig
Feed forward kS property.
seedRelativeEncoder() - Method in class yams.motorcontrollers.local.NovaWrapper
 
serialCommsIssueWarning - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
NavX serial comm issue.
setClosedLoopRampRate(Time) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setClosedLoopSlot(SmartMotorController.ClosedLoopControllerSlot) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setDutyCycle(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setEncoderInverted(boolean) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setEncoderPosition(Angle) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setEncoderPosition(Distance) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setEncoderVelocity(AngularVelocity) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setEncoderVelocity(LinearVelocity) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setExponentialProfile(OptionalDouble, OptionalDouble, Optional<Voltage>) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setFeedback(double, double, double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setFeedforward(double, double, double, double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setIdleMode(SmartMotorControllerConfig.MotorMode) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKa(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKd(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKg(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKi(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKp(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKs(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setKv(double) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMeasurementLowerLimit(Distance) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMeasurementUpperLimit(Distance) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMechanismCircumference(Distance) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMechanismGearing(MechanismGearing) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMechanismLimits(Angle, Angle) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMechanismLimitsEnabled(boolean) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMechanismLowerLimit(Angle) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMechanismUpperLimit(Angle) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMotionProfileMaxAcceleration(AngularAcceleration) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMotionProfileMaxAcceleration(LinearAcceleration) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMotionProfileMaxJerk(Velocity<AngularAccelerationUnit>) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMotionProfileMaxVelocity(AngularVelocity) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMotionProfileMaxVelocity(LinearVelocity) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setMotorInverted(boolean) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setOpenLoopRampRate(Time) - Method in class yams.motorcontrollers.local.NovaWrapper
Deprecated.
setPosition(Angle) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setPosition(Distance) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setStatorCurrentLimit(Current) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setSupplyCurrentLimit(Current) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setupSimulation() - Method in class yams.motorcontrollers.local.NovaWrapper
 
setVelocity(AngularVelocity) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setVelocity(LinearVelocity) - Method in class yams.motorcontrollers.local.NovaWrapper
 
setVoltage(Voltage) - Method in class yams.motorcontrollers.local.NovaWrapper
 
simIterate() - Method in class yams.motorcontrollers.local.NovaWrapper
 
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.
SMARTIO - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
Device attached to the roboRIO SmartIO port (DIO/Analog).
SPARKFLEX - Enum constant in enum class swervelib.parser.deserializer.reflections.REVDevices.MotorControllerType
SPARKFLEX - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
SparkFlex Motor Controller
SPARKMAX - Enum constant in enum class swervelib.parser.deserializer.reflections.REVDevices.MotorControllerType
SPARKMAX - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
SparkMax Motor Controller
SPLINE_ENCODER - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
REV Robotics Spline Encoder, (if you use this for an azimuth encoder...
SPLINEENCODER - Enum constant in enum class swervelib.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
SRXMAG - Enum constant in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
SRX Mag encoder.
startCtrlCycle() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
Start the ctrl timer to measure cycle time, independent of periodic loops.
startOdomCycle() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
Start the odom cycle timer to calculate how long each odom took.
statorCurrentLimit - Variable in class swervelib.parser.json.PhysicalPropertiesJson
The current limit in AMPs to apply to the motors.
STUDICA - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
Studica
STUDICA - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
Studica.
StudicaLibDevices - Class in swervelib.parser.deserializer.reflections
StudicaLib Gyroscope and other devices.
StudicaLibDevices() - Constructor for class swervelib.parser.deserializer.reflections.StudicaLibDevices
 
swerveDrive() - Method in record class swervelib.parser.SwerveParser.SwerveDriveDevices
Returns the value of the swerveDrive record component.
SwerveDriveDevices(SwerveDrive, Object, SwerveParser.SwerveModuleDevices[]) - Constructor for record class swervelib.parser.SwerveParser.SwerveDriveDevices
Creates an instance of a SwerveDriveDevices record class.
swerveDriveJson - Static variable in class swervelib.parser.SwerveParser
Parsed swervedrive.json
SwerveDriveJson - Class in swervelib.parser.json
SwerveDrive JSON parsed class.
SwerveDriveJson() - Constructor for class swervelib.parser.json.SwerveDriveJson
 
SwerveDriveJson.GyroAxis - Enum Class in swervelib.parser.json
Gyro Axis
SwerveDriveTelemetry - Class in swervelib.telemetry
Telemetry to describe the SwerveDrive following frc-web-components.
SwerveDriveTelemetry() - Constructor for class swervelib.telemetry.SwerveDriveTelemetry
 
SwerveDriveTelemetry.TelemetryVerbosity - Enum Class in swervelib.telemetry
Verbosity of telemetry data sent back.
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.deserializer.reflections - package swervelib.parser.deserializer.reflections
 
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.telemetry - package swervelib.telemetry
Telemetry package for sending data to NT4 or SmartDashboard.
SwerveModuleDevices(Object, Object, Object) - Constructor for record class swervelib.parser.SwerveParser.SwerveModuleDevices
Creates an instance of a SwerveModuleDevices record class.
SwerveParser - Class in swervelib.parser
Helper class used to parse the JSON directory with specified configuration options.
SwerveParser() - Constructor for class swervelib.parser.SwerveParser
Construct a swerve parser.
SwerveParser.SwerveDriveDevices - Record Class in swervelib.parser
Raw hardware devices created by SwerveParser.createSwerveDriveDevices(SwerveDriveConfig), alongside the SwerveDrive it built.
SwerveParser.SwerveModuleDevices - Record Class in swervelib.parser
Raw hardware devices created for a single SwerveModule by SwerveParser.
synchronizeRelativeEncoder() - Method in class yams.motorcontrollers.local.NovaWrapper
 

T

TALONFX - Enum constant in enum class swervelib.parser.deserializer.reflections.CTREDevices.MotorControllerType
TALONFX - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
TalonFX Motor Controller wihtin KrakenX60 and KrakenX44
TALONFXS - Enum constant in enum class swervelib.parser.deserializer.reflections.CTREDevices.MotorControllerType
TALONFXS - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
TalonFXS Motor Controller
THRIFTY10PIN - Enum constant in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
10 pin encoder.
THRIFTYBOT - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
ThriftyLib
THRIFTYBOT - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
ThriftyBot.
THRIFTYBOT10PIN - Enum constant in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
ThriftyBot CAN encoder
ThriftyBotDevices - Class in swervelib.parser.deserializer.reflections
Reflection class for SmartMotorControllers and other devices from ThriftyBot.
ThriftyBotDevices() - Constructor for class swervelib.parser.deserializer.reflections.ThriftyBotDevices
 
ThriftyBotDevices.AbsoluteEncoderType - Enum Class in swervelib.parser.deserializer.reflections
Absolute encoder types.
ThriftyBotDevices.MotorControllerType - Enum Class in swervelib.parser.deserializer.reflections
Motor controller types.
THROUGHBORE - Enum constant in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
Through bore encoder.
toString() - Method in record class swervelib.parser.SwerveParser.SwerveDriveDevices
Returns a string representation of this record class.
toString() - Method in record class swervelib.parser.SwerveParser.SwerveModuleDevices
Returns a string representation of this record class.
type - Variable in class swervelib.parser.json.DeviceJson
The device type

U

UNKNOWN - Enum constant in enum class swervelib.parser.json.DeviceJson.VENDOR
Vendor could not be determined.
update() - Method in class swervelib.parser.Cache
Update the cache value and timestamp.
updateData() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
Upload data to smartdashboard
updateSettings - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
Update the telemetry settings that infrequently change.
updateSupplier(Supplier<T>) - Method in class swervelib.parser.Cache
Update the supplier to a new source.
updateSwerveTelemetrySettings() - Static method in class swervelib.telemetry.SwerveDriveTelemetry
Update only the settings that infrequently or never change.
updateValidityPeriod(long) - Method in class swervelib.parser.Cache
Update the validity period for the cached value, also updates the value.

V

v - Variable in class swervelib.parser.PIDFConfig
Feedforward kV property
valueOf(String) - Static method in enum class swervelib.parser.deserializer.reflections.CTREDevices.MotorControllerType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.reflections.REVDevices.AbsoluteEncoder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.reflections.REVDevices.MotorControllerType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.reflections.ThriftyBotDevices.MotorControllerType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.ReflectionsManager.AbsoluteEncoder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.ReflectionsManager.Gyro
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.ReflectionsManager.VENDOR
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.deserializer.ReflectionsManager.VendorMotorController
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.json.DeviceJson.VENDOR
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class swervelib.parser.json.SwerveDriveJson.GyroAxis
Returns the enum constant of this class with the specified name.
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.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.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.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.parser.deserializer.reflections.ThriftyBotDevices.AbsoluteEncoderType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class swervelib.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.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.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.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.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.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.parser.json.SwerveDriveJson.GyroAxis
Returns an array containing the constants of this enum class, in the order they are declared.
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.
verbosity - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The current telemetry verbosity level.

W

wheelLocations - Static variable in class swervelib.telemetry.SwerveDriveTelemetry
The Locations of the swerve drive wheels.

Y

yams.motorcontrollers.local - package yams.motorcontrollers.local
 
YAW - Enum constant in enum class swervelib.parser.json.SwerveDriveJson.GyroAxis
Yaw axis (Z)
A B C D E F G H I L M N P R S T U V W Y 
All Classes and Interfaces|All Packages