Button

class wpilib.buttons.Button[source]

Bases: wpilib.buttons.Trigger

This class provides an easy way to link commands to OI inputs.

It is very easy to link a button to a command. For instance, you could link the trigger button of a joystick to a “score” command.

This class represents a subclass of Trigger that is specifically aimed at buttons on an operator interface as a common use case of the more generalized Trigger objects. This is a simple wrapper around Trigger with the method names renamed to fit the Button object use.

cancelWhenPressed(command)[source]

Cancel the command when the button is pressed.

Parameters:command
toggleWhenPressed(command)[source]

Toggles the command whenever the button is pressed (on then off then on).

Parameters:command
whenPressed(command)[source]

Starts the given command whenever the button is newly pressed.

Parameters:command – the command to start
whenReleased(command)[source]

Starts the command when the button is released.

Parameters:command – the command to start
whileHeld(command)[source]

Constantly starts the given command while the button is held.

Command.start() will be called repeatedly while the button is held, and will be canceled when the button is released.

Parameters:command – the command to start