Index (core 2.0.0 API)

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

A

acceptableError(double) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the acceptable position error.
addStates(Class<? extends T>) - Method in class com.team2813.lib2813.subsystems.lightshow.Lightshow
addStates(Set<? extends State>) - Method in class com.team2813.lib2813.subsystems.lightshow.Lightshow
apply(int, int, int) - Method in interface com.team2813.lib2813.util.IntTriFunction
atPosition() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Determines if the motor is at the current setpoint, within the acceptable error.

B

build() - Method in interface com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params.Builder
buildConstants() - Method in class com.team2813.lib2813.util.BuildConstantsPublisher: Gets the build constants extracted from the publisher.
BuildConstants - Interface in com.team2813.lib2813.util: Holder for data collected at build time about the robot code.
BuildConstantsPublisher - Class in com.team2813.lib2813.util: Publishes build constants to NetworkTables.
BuildConstantsPublisher(Class<?>) - Constructor for class com.team2813.lib2813.util.BuildConstantsPublisher: Constructs a BuildConstantsPublisher.
builder() - Static method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params
buildTime() - Method in interface com.team2813.lib2813.util.BuildConstants: The time the code was built.

C

CAN - Search tag in com.team2813.lib2813.util.InputValidation.checkCanId(int)
CAN - Search tag in exception class com.team2813.lib2813.util.InvalidCanIdException
checkCanId(int) - Static method in class com.team2813.lib2813.util.InputValidation: Checks if the input is a valid CAN Id, and throws an exception if it isn't
clampOutput(double) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Extension point that allows subclasses to clamp the output.
CLOCKWISE - Enum constant in enum class com.team2813.lib2813.control.InvertType
close() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem
color() - Method in interface com.team2813.lib2813.subsystems.lightshow.State: Gets the color of this State.
com.team2813.lib2813.control - package com.team2813.lib2813.control
com.team2813.lib2813.preferences - package com.team2813.lib2813.preferences
com.team2813.lib2813.subsystems - package com.team2813.lib2813.subsystems
com.team2813.lib2813.subsystems.lightshow - package com.team2813.lib2813.subsystems.lightshow
com.team2813.lib2813.util - package com.team2813.lib2813.util
configPID(double, double, double) - Method in interface com.team2813.lib2813.control.PIDMotor
configPID(int, double, double, double) - Method in interface com.team2813.lib2813.control.PIDMotor
configPIDF(double, double, double, double) - Method in interface com.team2813.lib2813.control.PIDMotor
configPIDF(int, double, double, double, double) - Method in interface com.team2813.lib2813.control.PIDMotor
controller(PIDController) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the controller used to calculate the next value
controlMode - Variable in class com.team2813.lib2813.subsystems.MotorSubsystem
controlMode() - Method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Returns the value of the controlMode record component.
controlMode(ControlMode) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the control mode to use when giving output to the motor.
ControlMode - Enum Class in com.team2813.lib2813.control
ControlUtils - Class in com.team2813.lib2813.util: Utility class for comon control-related utility functions.
COUNTER_CLOCKWISE - Enum constant in enum class com.team2813.lib2813.control.InvertType

D

deadband(double, double) - Static method in class com.team2813.lib2813.util.ControlUtils: Deprecated, for removal: This API element is subject to removal in a future version.
Use edu.wpi.first.math.MathUtil.applyDeadband instead.
DEFAULT_ERROR - Static variable in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: The default acceptable position error.
DEFAULT_STARTING_POSITION - Static variable in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: The default starting position if one is not provided.
defaultState - Variable in class com.team2813.lib2813.subsystems.lightshow.Lightshow
DUTY_CYCLE - Enum constant in enum class com.team2813.lib2813.control.ControlMode

E

enable() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Engages the PID controller.
encoder - Variable in class com.team2813.lib2813.subsystems.MotorSubsystem
Encoder - Interface in com.team2813.lib2813.control: Specifies a device that can perceive rotational positions.
equals(Object) - Method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in exception class com.team2813.lib2813.util.InvalidCanIdException
equals(Object) - Method in record class com.team2813.lib2813.util.RobotFactory.Inputs: Indicates whether some other object is "equal to" this one.

F

FOLLOW_MASTER - Enum constant in enum class com.team2813.lib2813.control.InvertType
fromPreferences(String, Class<T>) - Static method in class com.team2813.lib2813.preferences.PersistedConfiguration: Creates a record class instance of the provided type, with fields populated from Preferences.
fromPreferences(String, T) - Static method in class com.team2813.lib2813.preferences.PersistedConfiguration: Creates a record class instance with fields populated from Preferences, using the provided defaults.

G

getAppliedCurrent() - Method in interface com.team2813.lib2813.control.Motor: Gets the current that is being applied onto the motor
getAppliedCurrent() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.ControlledMotor
getCanId() - Method in exception class com.team2813.lib2813.util.InvalidCanIdException
getMeasurement() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Returns the current position of the motor subsystem in the units specified by rotationUnit.
getPositionMeasure() - Method in interface com.team2813.lib2813.control.Encoder: Gets the position of the encoder
getSetpoint() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Returns the current setpoint as an angle.
getTab(String) - Method in interface com.team2813.lib2813.util.ShuffleboardTabs
getVelocityMeasure() - Method in interface com.team2813.lib2813.control.Encoder: Gets the velocity of the encoder
gitBranch() - Method in interface com.team2813.lib2813.util.BuildConstants: The current git branch when the code was built.
gitSubmitTime() - Method in interface com.team2813.lib2813.util.BuildConstants: The time the most recent commit at HEAD was submitted.

H

hashCode() - Method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Returns a hash code value for this object.
hashCode() - Method in exception class com.team2813.lib2813.util.InvalidCanIdException
hashCode() - Method in record class com.team2813.lib2813.util.RobotFactory.Inputs: Returns a hash code value for this object.

I

Inputs(ShuffleboardTabs) - Constructor for record class com.team2813.lib2813.util.RobotFactory.Inputs: Creates an instance of a Inputs record class.
InputValidation - Class in com.team2813.lib2813.util
intakeDemand() - Method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Returns the value of the intakeDemand record component.
intakeGamePiece() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem: Makes intake wheels spin in the intake direction.
intakeItemCommand() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem
IntTriFunction<T> - Interface in com.team2813.lib2813.util
InvalidCanIdException - Exception Class in com.team2813.lib2813.util: Signifies that a CAN Id was given to a function, and it was invalid
InvalidCanIdException(int) - Constructor for exception class com.team2813.lib2813.util.InvalidCanIdException
InvertType - Enum Class in com.team2813.lib2813.control
isActive() - Method in interface com.team2813.lib2813.subsystems.lightshow.State: Checks if the current state is active.
isEnabled() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Returns whether the PID controller is engaged.
isPositionalControl() - Method in enum class com.team2813.lib2813.control.ControlMode

L

Lightshow - Class in com.team2813.lib2813.subsystems.lightshow
Lightshow(Class<T>) - Constructor for class com.team2813.lib2813.subsystems.lightshow.Lightshow: Creates a new Lightshow subsystem using an enum.
Lightshow(Set<? extends State>) - Constructor for class com.team2813.lib2813.subsystems.lightshow.Lightshow: Creates a new Lightshow subsystem with a set of states.
log() - Method in class com.team2813.lib2813.util.BuildConstantsPublisher: Logs the build constants to the console.

M

METADATA_TABLE_NAME - Static variable in class com.team2813.lib2813.util.BuildConstantsPublisher: The name of the NetworkTable under which the build constants are published.
MOTION_MAGIC - Enum constant in enum class com.team2813.lib2813.control.ControlMode
motor - Variable in class com.team2813.lib2813.subsystems.MotorSubsystem
Motor - Interface in com.team2813.lib2813.control
motorRevsToTicks(double, int) - Static method in class com.team2813.lib2813.util.Units2813
motorRevsToWheelRevs(double, double) - Static method in class com.team2813.lib2813.util.Units2813
MotorSubsystem<T> - Class in com.team2813.lib2813.subsystems: Defines a generic subsystem comprising a motor and encoder.
MotorSubsystem(MotorSubsystem.MotorSubsystemConfiguration) - Constructor for class com.team2813.lib2813.subsystems.MotorSubsystem
MotorSubsystem.ControlledMotor - Class in com.team2813.lib2813.subsystems: A motor that is controlled by a subclass of MotorSubsystem.
MotorSubsystem.MotorSubsystemConfiguration - Class in com.team2813.lib2813.subsystems: A configuration for a MotorSubsystem
MotorSubsystemConfiguration(Motor, Encoder) - Constructor for class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Creates a new configuration for a MotorSubsystems.
MotorSubsystemConfiguration(PIDMotor) - Constructor for class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Creates a new config for MotorSubsystems using a motor that has a built-in encoder.

O

off - Static variable in class com.team2813.lib2813.subsystems.lightshow.Lightshow: A static state that signifies that the lights should be off, that is always applied
OPPOSE_MASTER - Enum constant in enum class com.team2813.lib2813.control.InvertType
outtakeDemand() - Method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Returns the value of the outtakeDemand record component.
outtakeGamePiece() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem: Makes intake wheels spin in the outtake direction.
outtakeItemCommand() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem

P

ParameterizedIntakeSubsystem - Class in com.team2813.lib2813.subsystems: A subsystem for an intake.
ParameterizedIntakeSubsystem(Motor, ParameterizedIntakeSubsystem.Params) - Constructor for class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem
ParameterizedIntakeSubsystem.Params - Record Class in com.team2813.lib2813.subsystems
ParameterizedIntakeSubsystem.Params.Builder - Interface in com.team2813.lib2813.subsystems
Params(ControlMode, double, double) - Constructor for record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Creates an instance of a Params record class.
periodic() - Method in class com.team2813.lib2813.subsystems.lightshow.Lightshow
periodic() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Applies the PID output to the motor if this subsystem is enabled.
PersistedConfiguration - Class in com.team2813.lib2813.preferences: Initializes the fields of a Record Class from values stored in Preferences.
PID(double, double, double) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the PID constants for the controller
PIDMotor - Interface in com.team2813.lib2813.control
publish(NetworkTableInstance) - Method in class com.team2813.lib2813.util.BuildConstantsPublisher: Publishes the build constants to NetworkTables.
publishTo(NetworkTableInstance) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Enables publishing of data to the provided network table instance.

Q

QueueLightshow - Class in com.team2813.lib2813.subsystems.lightshow: A lightshow that changes color when a State transitions from inactive to active.
QueueLightshow(Class<T>) - Constructor for class com.team2813.lib2813.subsystems.lightshow.QueueLightshow
QueueLightshow(Set<State>) - Constructor for class com.team2813.lib2813.subsystems.lightshow.QueueLightshow

R

RobotFactory - Class in com.team2813.lib2813.util
RobotFactory.Inputs - Record Class in com.team2813.lib2813.util
rotationUnit - Variable in class com.team2813.lib2813.subsystems.MotorSubsystem
rotationUnit(AngleUnit) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the unit to use for PID calculations
rotationValues - Static variable in enum class com.team2813.lib2813.control.InvertType: A set of all InvertTypes that have a phoenix and spark max invert.

S

selectTab(String) - Method in interface com.team2813.lib2813.util.ShuffleboardTabs
set(ControlMode, double) - Method in interface com.team2813.lib2813.control.Motor: Sets the motor to run with a specified mode of control.
set(ControlMode, double) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.ControlledMotor: Sets the motor to run with a specified mode of control.
set(ControlMode, double, double) - Method in interface com.team2813.lib2813.control.Motor: Sets the motor to run with a specified mode of control, and feedForward.
set(ControlMode, double, double) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.ControlledMotor: Sets the motor to run with a specified mode of control, and feedForward.
setControlMode(ControlMode) - Method in interface com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params.Builder
setDefaultState(State) - Method in class com.team2813.lib2813.subsystems.lightshow.Lightshow: Sets the State to be used if none is given.
setIntakeDemand(double) - Method in interface com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params.Builder
setMotorDemand(double) - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem: Runs the motor with the provided demand value.
setMotorDemandCommand(double) - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem: Returns a command that runs the motor with the provided demand value.
setOuttakeDemand(double) - Method in interface com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params.Builder
setPosition(Angle) - Method in interface com.team2813.lib2813.control.Encoder: Sets the position of the encoder
setSetpoint(T) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Sets the desired setpoint to the provided value, and enables the PID control.
setSetpointCommand(T) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Returns a command that sets the desired setpoint to the provided value.
shuffleboard() - Method in record class com.team2813.lib2813.util.RobotFactory.Inputs: Returns the value of the shuffleboard record component.
ShuffleboardTabs - Interface in com.team2813.lib2813.util: Wrapper around Shuffleboard.getTab(java.lang.String), for providing a seam for testing.
startingPosition(Angle) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the initial setpoint of the controller
startingPosition(Supplier<Angle>) - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.MotorSubsystemConfiguration: Sets the initial setpoint of the controller from the current value of a supplier.
startRobot(Function<RobotFactory.Inputs, T>) - Static method in class com.team2813.lib2813.util.RobotFactory
State - Interface in com.team2813.lib2813.subsystems.lightshow
states - Variable in class com.team2813.lib2813.subsystems.lightshow.Lightshow
stopMotor() - Method in interface com.team2813.lib2813.control.Motor: Stops the motor.
stopMotor() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem.ControlledMotor: Stops the motor.
stopMotor() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Stops the motor.
stopMotor() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem: Stops the motor.
stopMotorCommand() - Method in class com.team2813.lib2813.subsystems.MotorSubsystem: Returns a command that stops the motor.
stopMotorCommand() - Method in class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem

T

ticksToMotorRevs(double, int) - Static method in class com.team2813.lib2813.util.Units2813
toString() - Method in record class com.team2813.lib2813.subsystems.ParameterizedIntakeSubsystem.Params: Returns a string representation of this record class.
toString() - Method in record class com.team2813.lib2813.util.RobotFactory.Inputs: Returns a string representation of this record class.

U

Units2813 - Class in com.team2813.lib2813.util
update() - Method in class com.team2813.lib2813.subsystems.lightshow.Lightshow: Updates the current States.
update() - Method in class com.team2813.lib2813.subsystems.lightshow.QueueLightshow
useColor(Color) - Method in class com.team2813.lib2813.subsystems.lightshow.Lightshow: Sets the lights to the provided color.

V

valueOf(String) - Static method in enum class com.team2813.lib2813.control.ControlMode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.team2813.lib2813.control.InvertType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.team2813.lib2813.control.ControlMode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.team2813.lib2813.control.InvertType: Returns an array containing the constants of this enum class, in the order they are declared.
VELOCITY - Enum constant in enum class com.team2813.lib2813.control.ControlMode
VOLTAGE - Enum constant in enum class com.team2813.lib2813.control.ControlMode

W

wheelRevsToMotorRevs(double, double) - Static method in class com.team2813.lib2813.util.Units2813

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