Package edu.wpi.first.wpilibj2.command

Class ProfiledPIDCommand

java.lang.Object

edu.wpi.first.wpilibj2.command.Command

edu.wpi.first.wpilibj2.command.ProfiledPIDCommand

All Implemented Interfaces:

Sendable

public class ProfiledPIDCommand
extends Command

A command that controls an output with a ProfiledPIDController. Runs forever by default - to add exit conditions and/or other behavior, subclass this class. The controller calculation and output are performed synchronously in the command's execute() method.

This class is provided by the NewCommands VendorDep

Nested Class Summary

Nested classes/interfaces inherited from class edu.wpi.first.wpilibj2.command.Command

Command.InterruptionBehavior

Field Summary

Fields

Modifier and Type	Field	Description
protected ProfiledPIDController	m_controller	Profiled PID controller.
protected Supplier<TrapezoidProfile.State>	m_goal	Goal getter.
protected DoubleSupplier	m_measurement	Measurement getter.
protected BiConsumer<Double,TrapezoidProfile.State>	m_useOutput	Profiled PID controller output consumer.

Fields inherited from class edu.wpi.first.wpilibj2.command.Command

m_requirements

Constructor Summary

Constructors

Constructor	Description
ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, double goal, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)	Creates a new PIDCommand, which controls the given output with a ProfiledPIDController.
ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, TrapezoidProfile.State goal, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)	Creates a new PIDCommand, which controls the given output with a ProfiledPIDController.
ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, DoubleSupplier goalSource, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)	Creates a new PIDCommand, which controls the given output with a ProfiledPIDController.
ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, Supplier<TrapezoidProfile.State> goalSource, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)	Creates a new PIDCommand, which controls the given output with a ProfiledPIDController.

Method Summary

Modifier and Type	Method	Description
void	end(boolean interrupted)	The action to take when the command ends.
void	execute()	The main body of a command.
ProfiledPIDController	getController()	Returns the ProfiledPIDController used by the command.
void	initialize()	The initial subroutine of a command.

Methods inherited from class edu.wpi.first.wpilibj2.command.Command

addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isFinished, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

m_controller

protected final ProfiledPIDController m_controller

Profiled PID controller.

m_measurement

protected DoubleSupplier m_measurement

Measurement getter.

m_goal

protected Supplier<TrapezoidProfile.State> m_goal

Goal getter.

m_useOutput

protected BiConsumer<Double,TrapezoidProfile.State> m_useOutput

Profiled PID controller output consumer.

Constructor Details

ProfiledPIDCommand

public ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, Supplier<TrapezoidProfile.State> goalSource, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)

Creates a new PIDCommand, which controls the given output with a ProfiledPIDController. Goal velocity is specified.

Parameters:

controller - the controller that controls the output.

measurementSource - the measurement of the process variable

goalSource - the controller's goal

useOutput - the controller's output

requirements - the subsystems required by this command

ProfiledPIDCommand

public ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, DoubleSupplier goalSource, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)

Creates a new PIDCommand, which controls the given output with a ProfiledPIDController. Goal velocity is implicitly zero.

Parameters:

controller - the controller that controls the output.

measurementSource - the measurement of the process variable

goalSource - the controller's goal

useOutput - the controller's output

requirements - the subsystems required by this command

ProfiledPIDCommand

public ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, TrapezoidProfile.State goal, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)

Creates a new PIDCommand, which controls the given output with a ProfiledPIDController. Goal velocity is specified.

Parameters:

controller - the controller that controls the output.

measurementSource - the measurement of the process variable

goal - the controller's goal

useOutput - the controller's output

requirements - the subsystems required by this command

ProfiledPIDCommand

public ProfiledPIDCommand(ProfiledPIDController controller, DoubleSupplier measurementSource, double goal, BiConsumer<Double,TrapezoidProfile.State> useOutput, Subsystem... requirements)

Creates a new PIDCommand, which controls the given output with a ProfiledPIDController. Goal velocity is implicitly zero.

Parameters:

controller - the controller that controls the output.

measurementSource - the measurement of the process variable

goal - the controller's goal

useOutput - the controller's output

requirements - the subsystems required by this command

Method Details

initialize

public void initialize()

Description copied from class: Command

The initial subroutine of a command. Called once when the command is initially scheduled.

Overrides:

initialize in class Command

execute

public void execute()

Description copied from class: Command

The main body of a command. Called repeatedly while the command is scheduled.

Overrides:

execute in class Command

end

public void end(boolean interrupted)

Description copied from class: Command

The action to take when the command ends. Called when either the command finishes normally, or when it interrupted/canceled.

Do not schedule commands here that share requirements with this command. Use Command.andThen(Command...) instead.

Overrides:

end in class Command

Parameters:

interrupted - whether the command was interrupted/canceled

getController

public ProfiledPIDController getController()

Returns the ProfiledPIDController used by the command.

Returns:

The ProfiledPIDController