Index (eye-of-providence main API)

C D G I K L M P R S T U V X
All Classes All Packages

C

CANMotorConfig - Class in com.alumiboti5590.eop.components.motors.util: CANMotorConfig packages together the CAN IDs of motors and if they should be inverted or not.
CANMotorConfig(int, boolean) - Constructor for class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Create a new CAN bus motor configuration with brake mode enabled by default
CANMotorConfig(int, boolean, MotorIdleMode) - Constructor for class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Create a new CAN bus motor configuration with brake mode enabled by default
CANSparkMaxUtil - Class in com.alumiboti5590.eop.components.motors.util: Sets motor usage for a Spark Max motor controller
CANSparkMaxUtil.Usage - Enum in com.alumiboti5590.eop.components.motors.util
com.alumiboti5590.eop.components - package com.alumiboti5590.eop.components: Classes and abstractions of electrical, pneumatic, and physical components that are not complex enough to be subsystems, such as motor controllers and extra gyros.
com.alumiboti5590.eop.components.motors.util - package com.alumiboti5590.eop.components.motors.util: Utilities, shortcuts, and helpers that are not motors themselves, but help manage motors.
com.alumiboti5590.eop.controllers - package com.alumiboti5590.eop.controllers: Features, classes, and helpers associated with tuning and managing human-interfacing controllers.
com.alumiboti5590.eop.pid - package com.alumiboti5590.eop.pid: Features, classes, and helpers associated with tuning and managing PID controllers.
com.alumiboti5590.eop.properties - package com.alumiboti5590.eop.properties: Contains the RobotProperty class that allows for dynamically loading configuration values.
com.alumiboti5590.eop.subsystems.drivetrain.tank - package com.alumiboti5590.eop.subsystems.drivetrain.tank: Classes to quickly get started working with a drive chassis that is 'tank drive'-based.
configureDifferentialDrive(MotorController, MotorController) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive
curvatureDrive(double, double, boolean, boolean) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Given a movement speed and a rotational speed, move the robot.

D

DEFAULT_CURRENT_LIMIT - Static variable in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive: Limit the motors to the following AMPS to prevent brownouts, trips, or too much power being drawn when it really isn't needed.
DEFAULT_CURRENT_LIMIT - Static variable in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive: Limit the motors to the following AMPS to prevent brownouts, trips, or too much power being drawn when it really isn't needed.
DEFAULT_PEAK_OUTPUT - Static variable in class com.alumiboti5590.eop.pid.PIDGains: By default, let motors spin up to full speed.
DEFAULT_RAMP_RATE - Static variable in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive: The default ramp rate, meaning the motors will take this long (in seconds) to accelerate to full speed to prevent damage to the motor or subsystems.
DEFAULT_RAMP_RATE - Static variable in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive: The default ramp rate, meaning the motors will take this long (in seconds) to accelerate to full speed to prevent damage to the motor or subsystems.
DEFAULT_TELEOP_DRIVE_TYPE - Static variable in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: The default drive type to use if one is not selected in the SmartDashboard

G

getAButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the A button press as a Trigger to be used in Command-based programming.
getBackButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Back button press as a Trigger to be used in Command-based programming.
getBButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the B button press as a Trigger to be used in Command-based programming.
getBoolean(Object) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getBoolean(java.lang.String) but takes anything with a toString() method - which is everything in Java - so you can pass enumerations and the sort.
getBoolean(Object, String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getBoolean(java.lang.Object) but takes a default value if the property is not defined, instead of raising an exception.
getBoolean(String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Returns the property as a boolean.
getBoolean(String, boolean) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getBoolean(java.lang.String) but takes a default value if the property is not defined, instead of raising an exception.
getCANMotorConfig(String) - Static method in class com.alumiboti5590.eop.properties.RobotPropertyUtil: Shortcut to return a CANMotorConfig using the RobotProperty class and a motor name.
getCurrentPropertyPath() - Method in class com.alumiboti5590.eop.properties.RobotProperty: Returns the currently loaded property file path for debugging purposes
getDouble(Object) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getDouble(java.lang.String) but takes anything with a toString() method - which is everything in Java - so you can pass enumerations and the sort.
getDouble(Object, String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getDouble(java.lang.Object) but takes a default value if the property is not defined, instead of raising an exception.
getDouble(String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Returns the property as a double.
getDouble(String, double) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getDouble(java.lang.String) but takes a default value if the property is not defined, instead of raising an exception.
getEncoder(String) - Static method in class com.alumiboti5590.eop.properties.RobotPropertyUtil: Shortcut to return a CANMotorConfig using the RobotProperty class and an encoder name.
getInt(Object) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getInt(java.lang.String) but takes anything with a toString() method - which is everything in Java - so you can pass enumerations and the sort.
getInt(Object, String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getInt(java.lang.Object) but takes a default value if the property is not defined, instead of raising an exception.
getInt(String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Returns the property as an integer.
getInt(String, int) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getInt(java.lang.String) but takes a default value if the property is not defined, instead of raising an exception.
getLeftBumperTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Left Bumper button press as a Trigger to be used in Command-based programming.
getLeftStickButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Left Stick button press as a Trigger to be used in Command-based programming.
getLeftTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Left Trigger pressed as a Trigger to be used in Command-based programming.
getLeftTriggerPressed() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns if the Left Trigger axis is pushed in enough to be considered "pressed", using XboxController.triggerAsTriggerDeadzones as the minimum value required to be considered "pressed".
getLimitSwitch(String) - Static method in class com.alumiboti5590.eop.properties.RobotPropertyUtil: Shortcut to return a LimitSwitch using the RobotProperty class and a motor name.
getName() - Method in enum com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive.TeleopDriveType
getProperty(String) - Method in class com.alumiboti5590.eop.properties.RobotProperty: An override of the Java Properties.getProperty(String) method, but use getString(String) instead.
getRightBumperTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Right Bumper button press as a Trigger to be used in Command-based programming.
getRightStickButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Right Stick button press as a Trigger to be used in Command-based programming.
getRightTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Right Trigger pressed as a Trigger to be used in Command-based programming.
getRightTriggerPressed() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns if the Right Trigger axis is pushed in enough to be considered "pressed", using XboxController.triggerAsTriggerDeadzones as the minimum value required to be considered "pressed".
getStartButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Start button press as a Trigger to be used in Command-based programming.
getString(Object) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getString(java.lang.String) but takes anything with a toString() method - which is everything in Java - so you can pass enumerations and the sort.
getString(Object, String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getString(java.lang.Object) but takes a default value if the property is not defined, instead of raising an exception.
getString(String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Returns the property as a string.
getString(String, String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Same as RobotProperty.getString(java.lang.String) but takes a default value if the property is not defined, instead of raising an exception.
getTeleopDriveTypeSendableChooser() - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Returns the SendableChooser needed to pick the desired drive type from the SmartDashboard / Shuffleboard
getXButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the X button press as a Trigger to be used in Command-based programming.
getYButtonTrigger() - Method in class com.alumiboti5590.eop.controllers.XboxController: Returns the Y button press as a Trigger to be used in Command-based programming.

I

isEngaged() - Method in class com.alumiboti5590.eop.components.LimitSwitch: Same as get(), but it's a bit more clearer on the physical result of the limit switch being pressed and engaged, or not.

K

kAll - com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil.Usage
kBrake - com.alumiboti5590.eop.components.motors.util.MotorIdleMode: The motor will attempt to 'soft brake' itself when the speed is set to zero
kCANBusID - Variable in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: The CAN bus ID of the motor
kCoast - com.alumiboti5590.eop.components.motors.util.MotorIdleMode: The motor will not 'fight' any external forces against it when the speed is set to zero
kCurvature - com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive.TeleopDriveType
kD - Variable in class com.alumiboti5590.eop.pid.PIDGains
kFF - Variable in class com.alumiboti5590.eop.pid.PIDGains
kI - Variable in class com.alumiboti5590.eop.pid.PIDGains
kIdleMode - Variable in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Determines the default idle mode of the motor; if it should be braking or coasting
kIsInverted - Variable in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: If the motor power output should be inverted or not
kIzone - Variable in class com.alumiboti5590.eop.pid.PIDGains
kMinimal - com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil.Usage
kP - Variable in class com.alumiboti5590.eop.pid.PIDGains
kPeakMaxOutput - Variable in class com.alumiboti5590.eop.pid.PIDGains
kPeakMinOutput - Variable in class com.alumiboti5590.eop.pid.PIDGains
kPositionOnly - com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil.Usage
kTank - com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive.TeleopDriveType
kVelocityOnly - com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil.Usage

L

LimitSwitch - Class in com.alumiboti5590.eop.components: Shortcut wrapper around the WPI DigitalInput class for a Digital I/O-configured Limit Switch.
LimitSwitch(int) - Constructor for class com.alumiboti5590.eop.components.LimitSwitch: Create an instance of a LimitSwitch class.

M

MotorIdleMode - Enum in com.alumiboti5590.eop.components.motors.util: A single interface for controlling motor idles that allows for spanning RevRobotics or CTRE libraries.

P

PIDGains - Class in com.alumiboti5590.eop.pid: PIDGains allows for easily storing PID values in an object that can be pulled out and used against PID controllers.
PIDGains(double, double, double) - Constructor for class com.alumiboti5590.eop.pid.PIDGains: PIDGains constructor with only the P, I, and D values provided
PIDGains(double, double, double, double, double, double) - Constructor for class com.alumiboti5590.eop.pid.PIDGains: PIDGains constructor with all values but a mirrored peak value.
PIDGains(double, double, double, double, double, double, double) - Constructor for class com.alumiboti5590.eop.pid.PIDGains: PIDGains constructor with all values potentially defined, including non-symmetrical values for the peak minimum and maximum values.

R

resetOdometry() - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive
resetOdometry() - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive
resetOdometry() - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Reset the encoders and gyroscope readings.
RobotProperty - Class in com.alumiboti5590.eop.properties: RobotProperty is an extension of normal Java Properties, but can be accessed in a static manner.
RobotPropertyUtil - Class in com.alumiboti5590.eop.properties: RobotPropertyUtil is used to shortcut many component creations using common naming conventions such as motors, encoders, and more.
RobotPropertyUtil() - Constructor for class com.alumiboti5590.eop.properties.RobotPropertyUtil

S

setAccelerationRampRate(double) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive
setAccelerationRampRate(double) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive
setAccelerationRampRate(double) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Sets the ramp rate for open loop control modes.
setCANSparkMaxBusUsage(CANSparkMax, CANSparkMaxUtil.Usage) - Static method in class com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil: This function allows reducing a Spark Max's CAN bus utilization by reducing the periodic status frame period of nonessential frames from 20ms to 500ms.
setCANSparkMaxBusUsage(CANSparkMax, CANSparkMaxUtil.Usage, boolean) - Static method in class com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil: This function allows reducing a Spark Max's CAN bus utilization by reducing the periodic status frame period of nonessential frames from 20ms to 500ms.
setCurrentLimit(int) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive
setCurrentLimit(int) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive
setCurrentLimit(int) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Sets the current limit in Amps.
setCurvatureQuickTurnSupplier(BooleanSupplier) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set if the robot should be allowed to 'quick turn' in curvature mode
setCurvatureSpeedSupplier(DoubleSupplier) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set the speed supplier for curvature drive mode
setCurvatureSteeringSupplier(DoubleSupplier) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set the rotation supplier for curvature drive mode
setDrivetrainUsage(CANSparkMaxUtil.Usage) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive: The following allows us to save precious time in our 20ms robot loop by not evaluating the Spark Max values any more than we really need to.
setInvertCurvatureSteering(boolean) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Sets if the curvature steering input should be inverted
setSidePIDGains(PIDGains) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive
setSidePIDGains(PIDGains) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive
setSidePIDGains(PIDGains) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set the PID controller gains for both sides of the tank drive.
setSquareTeleopInputs(boolean) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: If configured - which it is by default - then the speed inputs will be squared meaning less sensitivity at lower levels.
setTankDriveLeftSpeedSupplier(DoubleSupplier) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set the speed supplier for the left-side of the tank drive control
setTankDriveRightSpeedSupplier(DoubleSupplier) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set the speed supplier for the right-side of the tank drive control
setTeleopDriveType(TankDrive.TeleopDriveType) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Set the drive type to use in Tele-operated mode by the driver
SparkMaxBrushlessTankDrive - Class in com.alumiboti5590.eop.subsystems.drivetrain.tank: A TankDrive implementation using Spark Max motor controllers to control brushless motors.
SparkMaxBrushlessTankDrive(CANMotorConfig, CANMotorConfig, CANMotorConfig, CANMotorConfig) - Constructor for class com.alumiboti5590.eop.subsystems.drivetrain.tank.SparkMaxBrushlessTankDrive: Creates a new drivetrain from the provided motor and optionally provided encoders
stop() - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Stops both sides of the tank drive when called.

T

TalonSRXBrushedTankDrive - Class in com.alumiboti5590.eop.subsystems.drivetrain.tank: A TankDrive implementation using Talon SRX motor controllers to control brushed motors.
TalonSRXBrushedTankDrive(CANMotorConfig, CANMotorConfig, CANMotorConfig, CANMotorConfig, Encoder, Encoder) - Constructor for class com.alumiboti5590.eop.subsystems.drivetrain.tank.TalonSRXBrushedTankDrive: Creates a new drivetrain from the provided motor and optionally provided encoders
tankDrive(double, double, boolean) - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: Given a speed for the left and right side, respectively, set the motor speeds as given.
TankDrive - Class in com.alumiboti5590.eop.subsystems.drivetrain.tank: TankDrive abstracts out the control methods needed for a Tank Drive chassis subsystem, where each side of the robot acts as it's own system, similar to a tank - hence the name.
TankDrive() - Constructor for class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive
TankDrive.TeleopDriveType - Enum in com.alumiboti5590.eop.subsystems.drivetrain.tank: TeleopDriveType is an enumeration that allows for selecting the drive type during the tele-operated period for a tank drive chassis.
teleopOpenDrive() - Method in class com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive: The main method to control the drivetrain during teleop.
toIdleMode() - Method in enum com.alumiboti5590.eop.components.motors.util.MotorIdleMode: Returns the corresponding value of RevRobotics' IdleMode
toNeutralMode() - Method in enum com.alumiboti5590.eop.components.motors.util.MotorIdleMode: Returns the corresponding value of CTRE's NeutralMode
toSparkMaxBrushless() - Method in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Converts the CAN motor config into a Spark Max controlling a brushless motor, such as a Neo or Neo 550
toTalonSRX() - Method in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Converts the CAN motor config into a Talon SRX controlling a brushed motor, such as a CIM, 775, or Redline.
toWPITalonSRX() - Method in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Converts the CAN motor config into a Talon SRX controlling a brushed motor, such as a CIM, 775, or Redline.

U

UNSAFE_setSingleton(String) - Static method in class com.alumiboti5590.eop.properties.RobotProperty: Used only for testing, so do not call this in code.
UNSAFE_toSparkMaxBrushed() - Method in class com.alumiboti5590.eop.components.motors.util.CANMotorConfig: Converts the CAN motor config into a Spark Max controlling a brushed motor, such as a CIM, 775, or Redline.

V

valueOf(String) - Static method in enum com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil.Usage: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.alumiboti5590.eop.components.motors.util.MotorIdleMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive.TeleopDriveType: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.alumiboti5590.eop.components.motors.util.CANSparkMaxUtil.Usage: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.alumiboti5590.eop.components.motors.util.MotorIdleMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.alumiboti5590.eop.subsystems.drivetrain.tank.TankDrive.TeleopDriveType: Returns an array containing the constants of this enum type, in the order they are declared.

X

XboxController - Class in com.alumiboti5590.eop.controllers: A subclass of the WPILib XboxController containing useful additions such as deadzone management and Triggers for Command-based programming.
XboxController(int) - Constructor for class com.alumiboti5590.eop.controllers.XboxController: Creates a new XboxController listener on the provided port.
XboxController(int, double) - Constructor for class com.alumiboti5590.eop.controllers.XboxController: Creates a new XboxController listener on the provided port with the provided deadzone values.

C D G I K L M P R S T U V X
All Classes All Packages