Class CommandSteamController

java.lang.Object
org.wpilib.command3.button.CommandSteamController
public class CommandSteamController extends Object
A version of SteamController with Trigger factories for command-based.
See Also:

  • Constructor Details

    • CommandSteamController

      public CommandSteamController(int port)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the default scheduler using its default event loop.
      Parameters:
      port - The port index on the Driver Station that the controller is plugged into.

    • CommandSteamController

      public CommandSteamController(SteamController controller)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the default scheduler using its default event loop.
      Parameters:
      controller - The SteamController object to use for this controller.

    • CommandSteamController

      public CommandSteamController(Scheduler scheduler, int port)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the given scheduler using its default event loop.
      Parameters:
      scheduler - The scheduler that should execute the triggered commands.
      port - The port index on the Driver Station that the controller is plugged into.

    • CommandSteamController

      public CommandSteamController(Scheduler scheduler, SteamController controller)
      Construct an instance of a controller. Commands bound to buttons on the controller will be scheduled on the given scheduler using its default event loop.
      Parameters:
      scheduler - The scheduler that should execute the triggered commands.
      controller - The SteamController object to use for this controller.

  • Method Details

    • getHID

      public CommandGenericHID getHID()
      Get the underlying CommandGenericHID object.
      Returns:
      the wrapped CommandGenericHID object

    • getController

      public SteamController getController()
      Get the wrapped controller object.
      Returns:
      the wrapped controller object

    • a

      public Trigger a()
      Constructs a Trigger instance around the A button's digital signal.
      Returns:
      a Trigger instance representing the A button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • a

      public Trigger a(EventLoop loop)
      Constructs a Trigger instance around the A button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the A button's digital signal attached to the given loop.

    • b

      public Trigger b()
      Constructs a Trigger instance around the B button's digital signal.
      Returns:
      a Trigger instance representing the B button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • b

      public Trigger b(EventLoop loop)
      Constructs a Trigger instance around the B button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the B button's digital signal attached to the given loop.

    • x

      public Trigger x()
      Constructs a Trigger instance around the X button's digital signal.
      Returns:
      a Trigger instance representing the X button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • x

      public Trigger x(EventLoop loop)
      Constructs a Trigger instance around the X button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the X button's digital signal attached to the given loop.

    • y

      public Trigger y()
      Constructs a Trigger instance around the Y button's digital signal.
      Returns:
      a Trigger instance representing the Y button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • y

      public Trigger y(EventLoop loop)
      Constructs a Trigger instance around the Y button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Y button's digital signal attached to the given loop.

    • steam

      public Trigger steam()
      Constructs a Trigger instance around the Steam button's digital signal.
      Returns:
      a Trigger instance representing the Steam button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • steam

      public Trigger steam(EventLoop loop)
      Constructs a Trigger instance around the Steam button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Steam button's digital signal attached to the given loop.

    • view

      public Trigger view()
      Constructs a Trigger instance around the View button's digital signal.
      Returns:
      a Trigger instance representing the View button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • view

      public Trigger view(EventLoop loop)
      Constructs a Trigger instance around the View button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the View button's digital signal attached to the given loop.

    • leftStick

      public Trigger leftStick()
      Constructs a Trigger instance around the Left Stick button's digital signal.
      Returns:
      a Trigger instance representing the Left Stick button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftStick

      public Trigger leftStick(EventLoop loop)
      Constructs a Trigger instance around the Left Stick button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Stick button's digital signal attached to the given loop.

    • rightStick

      public Trigger rightStick()
      Constructs a Trigger instance around the Right Stick button's digital signal.
      Returns:
      a Trigger instance representing the Right Stick button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightStick

      public Trigger rightStick(EventLoop loop)
      Constructs a Trigger instance around the Right Stick button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Stick button's digital signal attached to the given loop.

    • leftBumper

      public Trigger leftBumper()
      Constructs a Trigger instance around the Left Bumper button's digital signal.
      Returns:
      a Trigger instance representing the Left Bumper button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftBumper

      public Trigger leftBumper(EventLoop loop)
      Constructs a Trigger instance around the Left Bumper button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Bumper button's digital signal attached to the given loop.

    • rightBumper

      public Trigger rightBumper()
      Constructs a Trigger instance around the Right Bumper button's digital signal.
      Returns:
      a Trigger instance representing the Right Bumper button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightBumper

      public Trigger rightBumper(EventLoop loop)
      Constructs a Trigger instance around the Right Bumper button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Bumper button's digital signal attached to the given loop.

    • dpadUp

      public Trigger dpadUp()
      Constructs a Trigger instance around the Dpad Up button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Up button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • dpadUp

      public Trigger dpadUp(EventLoop loop)
      Constructs a Trigger instance around the Dpad Up button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Up button's digital signal attached to the given loop.

    • dpadDown

      public Trigger dpadDown()
      Constructs a Trigger instance around the Dpad Down button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Down button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • dpadDown

      public Trigger dpadDown(EventLoop loop)
      Constructs a Trigger instance around the Dpad Down button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Down button's digital signal attached to the given loop.

    • dpadLeft

      public Trigger dpadLeft()
      Constructs a Trigger instance around the Dpad Left button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Left button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • dpadLeft

      public Trigger dpadLeft(EventLoop loop)
      Constructs a Trigger instance around the Dpad Left button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Left button's digital signal attached to the given loop.

    • dpadRight

      public Trigger dpadRight()
      Constructs a Trigger instance around the Dpad Right button's digital signal.
      Returns:
      a Trigger instance representing the Dpad Right button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • dpadRight

      public Trigger dpadRight(EventLoop loop)
      Constructs a Trigger instance around the Dpad Right button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Dpad Right button's digital signal attached to the given loop.

    • QAM

      public Trigger QAM()
      Constructs a Trigger instance around the QAM button's digital signal.
      Returns:
      a Trigger instance representing the QAM button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • QAM

      public Trigger QAM(EventLoop loop)
      Constructs a Trigger instance around the QAM button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the QAM button's digital signal attached to the given loop.

    • rightPaddle1

      public Trigger rightPaddle1()
      Constructs a Trigger instance around the Right Paddle 1 button's digital signal.
      Returns:
      a Trigger instance representing the Right Paddle 1 button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightPaddle1

      public Trigger rightPaddle1(EventLoop loop)
      Constructs a Trigger instance around the Right Paddle 1 button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Paddle 1 button's digital signal attached to the given loop.

    • leftPaddle1

      public Trigger leftPaddle1()
      Constructs a Trigger instance around the Left Paddle 1 button's digital signal.
      Returns:
      a Trigger instance representing the Left Paddle 1 button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftPaddle1

      public Trigger leftPaddle1(EventLoop loop)
      Constructs a Trigger instance around the Left Paddle 1 button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Paddle 1 button's digital signal attached to the given loop.

    • rightPaddle2

      public Trigger rightPaddle2()
      Constructs a Trigger instance around the Right Paddle 2 button's digital signal.
      Returns:
      a Trigger instance representing the Right Paddle 2 button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightPaddle2

      public Trigger rightPaddle2(EventLoop loop)
      Constructs a Trigger instance around the Right Paddle 2 button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Paddle 2 button's digital signal attached to the given loop.

    • leftPaddle2

      public Trigger leftPaddle2()
      Constructs a Trigger instance around the Left Paddle 2 button's digital signal.
      Returns:
      a Trigger instance representing the Left Paddle 2 button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftPaddle2

      public Trigger leftPaddle2(EventLoop loop)
      Constructs a Trigger instance around the Left Paddle 2 button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Paddle 2 button's digital signal attached to the given loop.

    • leftTouchpad

      public Trigger leftTouchpad()
      Constructs a Trigger instance around the Left Touchpad button's digital signal.
      Returns:
      a Trigger instance representing the Left Touchpad button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftTouchpad

      public Trigger leftTouchpad(EventLoop loop)
      Constructs a Trigger instance around the Left Touchpad button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Touchpad button's digital signal attached to the given loop.

    • rightTouchpad

      public Trigger rightTouchpad()
      Constructs a Trigger instance around the Right Touchpad button's digital signal.
      Returns:
      a Trigger instance representing the Right Touchpad button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightTouchpad

      public Trigger rightTouchpad(EventLoop loop)
      Constructs a Trigger instance around the Right Touchpad button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Touchpad button's digital signal attached to the given loop.

    • leftStickTouch

      public Trigger leftStickTouch()
      Constructs a Trigger instance around the Left Stick Touch button's digital signal.
      Returns:
      a Trigger instance representing the Left Stick Touch button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftStickTouch

      public Trigger leftStickTouch(EventLoop loop)
      Constructs a Trigger instance around the Left Stick Touch button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Stick Touch button's digital signal attached to the given loop.

    • rightStickTouch

      public Trigger rightStickTouch()
      Constructs a Trigger instance around the Right Stick Touch button's digital signal.
      Returns:
      a Trigger instance representing the Right Stick Touch button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightStickTouch

      public Trigger rightStickTouch(EventLoop loop)
      Constructs a Trigger instance around the Right Stick Touch button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Stick Touch button's digital signal attached to the given loop.

    • leftGripTouch

      public Trigger leftGripTouch()
      Constructs a Trigger instance around the Left Grip Touch button's digital signal.
      Returns:
      a Trigger instance representing the Left Grip Touch button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • leftGripTouch

      public Trigger leftGripTouch(EventLoop loop)
      Constructs a Trigger instance around the Left Grip Touch button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Left Grip Touch button's digital signal attached to the given loop.

    • rightGripTouch

      public Trigger rightGripTouch()
      Constructs a Trigger instance around the Right Grip Touch button's digital signal.
      Returns:
      a Trigger instance representing the Right Grip Touch button's digital signal attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.
      See Also:

    • rightGripTouch

      public Trigger rightGripTouch(EventLoop loop)
      Constructs a Trigger instance around the Right Grip Touch button's digital signal.
      Parameters:
      loop - the event loop instance to attach the event to.
      Returns:
      a Trigger instance representing the Right Grip Touch button's digital signal attached to the given loop.

    • leftTrigger

      public Trigger leftTrigger(double threshold, EventLoop loop)
      Constructs a Trigger instance around the axis value of the Left Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      loop - the event loop instance to attach the Trigger to.
      Returns:
      a Trigger instance that is true when the Left Trigger axis exceeds the provided threshold, attached to the given event loop

    • leftTrigger

      public Trigger leftTrigger(double threshold)
      Constructs a Trigger instance around the axis value of the Left Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      Returns:
      a Trigger instance that is true when the Left Trigger axis exceeds the provided threshold, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

    • leftTrigger

      public Trigger leftTrigger()
      Constructs a Trigger instance around the axis value of the Left Trigger. The returned trigger will be true when the axis value is greater than 0.5.
      Returns:
      a Trigger instance that is true when the Left Trigger axis exceeds 0.5, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

    • rightTrigger

      public Trigger rightTrigger(double threshold, EventLoop loop)
      Constructs a Trigger instance around the axis value of the Right Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      loop - the event loop instance to attach the Trigger to.
      Returns:
      a Trigger instance that is true when the Right Trigger axis exceeds the provided threshold, attached to the given event loop

    • rightTrigger

      public Trigger rightTrigger(double threshold)
      Constructs a Trigger instance around the axis value of the Right Trigger. The returned trigger will be true when the axis value is greater than threshold.
      Parameters:
      threshold - the minimum axis value for the returned Trigger to be true. This value should be in the range [0, 1] where 0 is the unpressed state of the axis.
      Returns:
      a Trigger instance that is true when the Right Trigger axis exceeds the provided threshold, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

    • rightTrigger

      public Trigger rightTrigger()
      Constructs a Trigger instance around the axis value of the Right Trigger. The returned trigger will be true when the axis value is greater than 0.5.
      Returns:
      a Trigger instance that is true when the Right Trigger axis exceeds 0.5, attached to the default scheduler event loop on the scheduler passed to the controller's constructor, or the default scheduler if a scheduler was not explicitly provided.

    • getLeftX

      public double getLeftX()
      Get the Left X value of the controller.
      Returns:
      The axis value.

    • getLeftY

      public double getLeftY()
      Get the Left Y value of the controller.
      Returns:
      The axis value.

    • getRightX

      public double getRightX()
      Get the Right X value of the controller.
      Returns:
      The axis value.

    • getRightY

      public double getRightY()
      Get the Right Y value of the controller.
      Returns:
      The axis value.

    • getLeftTrigger

      public double getLeftTrigger()
      Get the Left Trigger value of the controller.
      Returns:
      The axis value.

    • getRightTrigger

      public double getRightTrigger()
      Get the Right Trigger value of the controller.
      Returns:
      The axis value.