RobotPy Commands v2
latest
Robot Programming
Getting Started
Upgrade Notes
Installation
Programmer's Guide
Frameworks
Hardware & Sensors
Camera & Vision
API Reference
WPILib API
NTCore API
CSCore API
Commands API
Utilities API
PyFRC API
HAL API
Apriltag API
WPIMath API
WPINet API
WPIUtil API
Third Party HW
CTRE API
NavX API
REVLib API
PathPlannerLib API
PhotonVision API
PWFusion API
Romi API
Additional Info
Troubleshooting
Support
FAQ
RobotPy Developers
Developer Documentation
RobotPy Commands v2
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
A
A() (commands2.button.CommandXboxController method)
addChild() (commands2.SubsystemBase method)
addCommands() (commands2.CommandGroupBase method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.SequentialCommandGroup method)
addRequirements() (commands2.CommandBase method)
alongWith() (commands2.Command method)
(commands2.ParallelCommandGroup method)
and_() (commands2.Trigger method)
andThen() (commands2.Command method)
asProxy() (commands2.Command method)
axisGreaterThan() (commands2.button.CommandGenericHID method)
axisLessThan() (commands2.button.CommandGenericHID method)
B
B() (commands2.button.CommandXboxController method)
back() (commands2.button.CommandXboxController method)
beforeStarting() (commands2.Command method)
Button (class in commands2.button)
button() (commands2.button.CommandGenericHID method)
(commands2.button.CommandJoystick method)
(commands2.button.CommandPS4Controller method)
(commands2.button.CommandXboxController method)
C
cancel() (commands2.Command method)
(commands2.CommandScheduler method)
cancelAll() (commands2.CommandScheduler method)
cancelWhenActive() (commands2.Trigger method)
cancelWhenPressed() (commands2.button.Button method)
circle() (commands2.button.CommandPS4Controller method)
clearButtons() (commands2.CommandScheduler method)
Command (class in commands2)
Command.InterruptionBehavior (class in commands2)
CommandBase (class in commands2)
CommandGenericHID (class in commands2.button)
CommandGroupBase (class in commands2)
CommandJoystick (class in commands2.button)
CommandPS4Controller (class in commands2.button)
commands2
module
commands2.button
module
commands2.cmd
module
CommandScheduler (class in commands2)
CommandXboxController (class in commands2.button)
ConditionalCommand (class in commands2)
cross() (commands2.button.CommandPS4Controller method)
D
deadline() (in module commands2.cmd)
deadlineWith() (commands2.Command method)
(commands2.ParallelDeadlineGroup method)
debounce() (commands2.Trigger method)
disable() (commands2.CommandScheduler method)
(commands2.PIDSubsystem method)
(commands2.ProfiledPIDSubsystem method)
E
either() (in module commands2.cmd)
enable() (commands2.CommandScheduler method)
(commands2.PIDSubsystem method)
(commands2.ProfiledPIDSubsystem method)
end() (commands2.Command method)
(commands2.ConditionalCommand method)
(commands2.FunctionalCommand method)
(commands2.MecanumControllerCommand method)
(commands2.NotifierCommand method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.PerpetualCommand method)
(commands2.PIDCommand method)
(commands2.ProfiledPIDCommand method)
(commands2.ProxyScheduleCommand method)
(commands2.RamseteCommand method)
(commands2.RepeatCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
(commands2.Swerve2ControllerCommand method)
(commands2.Swerve3ControllerCommand method)
(commands2.Swerve4ControllerCommand method)
(commands2.Swerve6ControllerCommand method)
(commands2.TrapezoidProfileCommand method)
(commands2.TrapezoidProfileCommandRadians method)
(commands2.WaitCommand method)
execute() (commands2.Command method)
(commands2.ConditionalCommand method)
(commands2.FunctionalCommand method)
(commands2.MecanumControllerCommand method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.PerpetualCommand method)
(commands2.PIDCommand method)
(commands2.ProfiledPIDCommand method)
(commands2.ProxyScheduleCommand method)
(commands2.RamseteCommand method)
(commands2.RepeatCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
(commands2.Swerve2ControllerCommand method)
(commands2.Swerve3ControllerCommand method)
(commands2.Swerve4ControllerCommand method)
(commands2.Swerve6ControllerCommand method)
(commands2.TrapezoidProfileCommand method)
(commands2.TrapezoidProfileCommandRadians method)
F
FunctionalCommand (class in commands2)
G
getActiveButtonLoop() (commands2.CommandScheduler method)
getController() (commands2.PIDCommand method)
(commands2.PIDSubsystem method)
(commands2.ProfiledPIDCommand method)
(commands2.ProfiledPIDSubsystem method)
getCurrentCommand() (commands2.Subsystem method)
getDefaultButtonLoop() (commands2.CommandScheduler method)
getDefaultCommand() (commands2.CommandScheduler method)
(commands2.Subsystem method)
getInstance() (commands2.CommandScheduler static method)
getInterruptionBehavior() (commands2.Command method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.RepeatCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
getName() (commands2.Command method)
(commands2.CommandBase method)
(commands2.SubsystemBase method)
getRequirements() (commands2.Command method)
(commands2.CommandBase method)
getSetpoint() (commands2.PIDSubsystem method)
getSubsystem() (commands2.CommandBase method)
(commands2.SubsystemBase method)
H
hasRequirement() (commands2.Command method)
I
initialize() (commands2.Command method)
(commands2.ConditionalCommand method)
(commands2.FunctionalCommand method)
(commands2.MecanumControllerCommand method)
(commands2.NotifierCommand method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.PerpetualCommand method)
(commands2.PIDCommand method)
(commands2.ProfiledPIDCommand method)
(commands2.ProxyScheduleCommand method)
(commands2.RamseteCommand method)
(commands2.RepeatCommand method)
(commands2.ScheduleCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
(commands2.Swerve2ControllerCommand method)
(commands2.Swerve3ControllerCommand method)
(commands2.Swerve4ControllerCommand method)
(commands2.Swerve6ControllerCommand method)
(commands2.TrapezoidProfileCommand method)
(commands2.TrapezoidProfileCommandRadians method)
(commands2.WaitCommand method)
initSendable() (commands2.CommandBase method)
(commands2.CommandScheduler method)
(commands2.ConditionalCommand method)
(commands2.ParallelDeadlineGroup method)
(commands2.RamseteCommand method)
(commands2.RepeatCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
(commands2.SubsystemBase method)
(commands2.WaitCommand method)
InstantCommand (class in commands2)
isComposed() (commands2.Command method)
isEnabled() (commands2.PIDSubsystem method)
(commands2.ProfiledPIDSubsystem method)
isFinished() (commands2.Command method)
(commands2.ConditionalCommand method)
(commands2.FunctionalCommand method)
(commands2.MecanumControllerCommand method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.ProxyScheduleCommand method)
(commands2.RamseteCommand method)
(commands2.RepeatCommand method)
(commands2.ScheduleCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
(commands2.Swerve2ControllerCommand method)
(commands2.Swerve3ControllerCommand method)
(commands2.Swerve4ControllerCommand method)
(commands2.Swerve6ControllerCommand method)
(commands2.TrapezoidProfileCommand method)
(commands2.TrapezoidProfileCommandRadians method)
(commands2.WaitCommand method)
(commands2.WaitUntilCommand method)
isGrouped() (commands2.Command method)
isScheduled() (commands2.Command method)
(commands2.CommandScheduler method)
J
JoystickButton (class in commands2.button)
K
kCancelIncoming (commands2.Command.InterruptionBehavior attribute)
kCancelSelf (commands2.Command.InterruptionBehavior attribute)
L
L1() (commands2.button.CommandPS4Controller method)
L2() (commands2.button.CommandPS4Controller method)
L3() (commands2.button.CommandPS4Controller method)
leftBumper() (commands2.button.CommandXboxController method)
leftStick() (commands2.button.CommandXboxController method)
leftTrigger() (commands2.button.CommandXboxController method)
M
MecanumControllerCommand (class in commands2)
module
commands2
commands2.button
commands2.cmd
N
name (commands2.Command.InterruptionBehavior property)
NetworkButton (class in commands2.button)
not_() (commands2.Trigger method)
nothing() (in module commands2.cmd)
NotifierCommand (class in commands2)
O
onCommandExecute() (commands2.CommandScheduler method)
onCommandFinish() (commands2.CommandScheduler method)
onCommandInitialize() (commands2.CommandScheduler method)
onCommandInterrupt() (commands2.CommandScheduler method)
onFalse() (commands2.Trigger method)
onTrue() (commands2.Trigger method)
options() (commands2.button.CommandPS4Controller method)
or_() (commands2.Trigger method)
P
parallel() (in module commands2.cmd)
ParallelCommandGroup (class in commands2)
ParallelDeadlineGroup (class in commands2)
ParallelRaceGroup (class in commands2)
periodic() (commands2.PIDSubsystem method)
(commands2.ProfiledPIDSubsystem method)
(commands2.Subsystem method)
(commands2.TrapezoidProfileSubsystem method)
(commands2.TrapezoidProfileSubsystemRadians method)
PerpetualCommand (class in commands2)
perpetually() (commands2.Command method)
PIDCommand (class in commands2)
PIDSubsystem (class in commands2)
POV() (commands2.button.CommandGenericHID method)
POVButton (class in commands2.button)
POVCenter() (commands2.button.CommandGenericHID method)
POVDown() (commands2.button.CommandGenericHID method)
POVDownLeft() (commands2.button.CommandGenericHID method)
POVDownRight() (commands2.button.CommandGenericHID method)
POVLeft() (commands2.button.CommandGenericHID method)
POVRight() (commands2.button.CommandGenericHID method)
POVUp() (commands2.button.CommandGenericHID method)
POVUpLeft() (commands2.button.CommandGenericHID method)
POVUpRight() (commands2.button.CommandGenericHID method)
print() (in module commands2.cmd)
PrintCommand (class in commands2)
ProfiledPIDCommand (class in commands2)
ProfiledPIDSubsystem (class in commands2)
ProxyScheduleCommand (class in commands2)
PS() (commands2.button.CommandPS4Controller method)
R
R1() (commands2.button.CommandPS4Controller method)
R2() (commands2.button.CommandPS4Controller method)
R3() (commands2.button.CommandPS4Controller method)
race() (in module commands2.cmd)
raceWith() (commands2.Command method)
(commands2.ParallelRaceGroup method)
RamseteCommand (class in commands2)
register() (commands2.Subsystem method)
registerSubsystem() (commands2.CommandScheduler method)
removeDefaultCommand() (commands2.CommandScheduler method)
(commands2.Subsystem method)
RepeatCommand (class in commands2)
repeatingSequence() (in module commands2.cmd)
requirementsDisjoint() (in module commands2)
requireUngrouped() (commands2.CommandScheduler method)
requiring() (commands2.CommandScheduler method)
resetInstance() (commands2.CommandScheduler static method)
rightBumper() (commands2.button.CommandXboxController method)
rightStick() (commands2.button.CommandXboxController method)
rightTrigger() (commands2.button.CommandXboxController method)
robotPeriodic() (commands2.TimedCommandRobot method)
run() (commands2.CommandScheduler method)
(commands2.Subsystem method)
(in module commands2.cmd)
RunCommand (class in commands2)
runEnd() (commands2.Subsystem method)
(in module commands2.cmd)
runOnce() (commands2.Subsystem method)
(in module commands2.cmd)
runsWhenDisabled() (commands2.Command method)
(commands2.ConditionalCommand method)
(commands2.ParallelCommandGroup method)
(commands2.ParallelDeadlineGroup method)
(commands2.ParallelRaceGroup method)
(commands2.PrintCommand method)
(commands2.RepeatCommand method)
(commands2.ScheduleCommand method)
(commands2.SelectCommand method)
(commands2.SequentialCommandGroup method)
(commands2.WaitCommand method)
(commands2.WaitUntilCommand method)
S
schedule() (commands2.Command method)
(commands2.CommandScheduler method)
ScheduleCommand (class in commands2)
select() (in module commands2.cmd)
SelectCommand (class in commands2)
sequence() (in module commands2.cmd)
SequentialCommandGroup (class in commands2)
setActiveButtonLoop() (commands2.CommandScheduler method)
setComposed() (commands2.Command method)
setDefaultCommand() (commands2.CommandScheduler method)
(commands2.Subsystem method)
setGoal() (commands2.ProfiledPIDSubsystem method)
(commands2.TrapezoidProfileSubsystem method)
(commands2.TrapezoidProfileSubsystemRadians method)
setGrouped() (commands2.Command method)
setName() (commands2.Command method)
(commands2.CommandBase method)
(commands2.SubsystemBase method)
setPeriod() (commands2.CommandScheduler method)
setSetpoint() (commands2.PIDSubsystem method)
setSubsystem() (commands2.CommandBase method)
(commands2.SubsystemBase method)
simulationPeriodic() (commands2.Subsystem method)
square() (commands2.button.CommandPS4Controller method)
start() (commands2.button.CommandXboxController method)
startEnd() (commands2.Subsystem method)
(in module commands2.cmd)
StartEndCommand (class in commands2)
Subsystem (class in commands2)
SubsystemBase (class in commands2)
Swerve2ControllerCommand (class in commands2)
Swerve3ControllerCommand (class in commands2)
Swerve4ControllerCommand (class in commands2)
Swerve6ControllerCommand (class in commands2)
T
TimedCommandRobot (class in commands2)
toggleOnFalse() (commands2.Trigger method)
toggleOnTrue() (commands2.Trigger method)
toggleWhenActive() (commands2.Trigger method)
toggleWhenPressed() (commands2.button.Button method)
top() (commands2.button.CommandJoystick method)
touchpad() (commands2.button.CommandPS4Controller method)
TrapezoidProfileCommand (class in commands2)
TrapezoidProfileCommandRadians (class in commands2)
TrapezoidProfileSubsystem (class in commands2)
TrapezoidProfileSubsystemRadians (class in commands2)
triangle() (commands2.button.CommandPS4Controller method)
Trigger (class in commands2)
trigger() (commands2.button.CommandJoystick method)
U
unregisterSubsystem() (commands2.CommandScheduler method)
until() (commands2.Command method)
V
value (commands2.Command.InterruptionBehavior property)
W
wait() (in module commands2.cmd)
WaitCommand (class in commands2)
waitUntil() (in module commands2.cmd)
WaitUntilCommand (class in commands2)
whenActive() (commands2.Trigger method)
whenHeld() (commands2.button.Button method)
whenInactive() (commands2.Trigger method)
whenPressed() (commands2.button.Button method)
whenReleased() (commands2.button.Button method)
whileActiveContinous() (commands2.Trigger method)
whileActiveOnce() (commands2.Trigger method)
whileFalse() (commands2.Trigger method)
whileHeld() (commands2.button.Button method)
whileTrue() (commands2.Trigger method)
withInterrupt() (commands2.Command method)
withTimeout() (commands2.Command method)
X
X() (commands2.button.CommandXboxController method)
Y
Y() (commands2.button.CommandXboxController method)
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds