Package org.wpilib.commands3.button

Class CommandPS5Controller

java.lang.Object
org.wpilib.commands3.button.CommandGenericHID
org.wpilib.commands3.button.CommandPS5Controller
public class CommandPS5Controller extends CommandGenericHID
A version of PS5Controller with Trigger factories for command-based.
See Also:

  • Constructor Details

    • CommandPS5Controller

      public CommandPS5Controller(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.

    • CommandPS5Controller

      public CommandPS5Controller(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.

  • Method Details

    • getHID

      public PS5Controller getHID()
      Get the underlying GenericHID object.
      Overrides:
      getHID in class CommandGenericHID
      Returns:
      the wrapped GenericHID object

    • square

      public Trigger square()
      Constructs a Trigger instance around the square button's digital signal.
      Returns:
      a Trigger instance representing the square 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:

    • square

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

    • cross

      public Trigger cross()
      Constructs a Trigger instance around the cross button's digital signal.
      Returns:
      a Trigger instance representing the cross 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:

    • cross

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

    • circle

      public Trigger circle()
      Constructs a Trigger instance around the circle button's digital signal.
      Returns:
      a Trigger instance representing the circle 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:

    • circle

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

    • triangle

      public Trigger triangle()
      Constructs a Trigger instance around the triangle button's digital signal.
      Returns:
      a Trigger instance representing the triangle 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:

    • triangle

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

    • L1

      public Trigger L1()
      Constructs a Trigger instance around the left trigger 1 button's digital signal.
      Returns:
      a Trigger instance representing the left trigger 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:

    • L1

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

    • R1

      public Trigger R1()
      Constructs a Trigger instance around the right trigger 1 button's digital signal.
      Returns:
      a Trigger instance representing the right trigger 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:

    • R1

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

    • L2

      public Trigger L2()
      Constructs a Trigger instance around the left trigger 2 button's digital signal.
      Returns:
      a Trigger instance representing the left trigger 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:

    • L2

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

    • R2

      public Trigger R2()
      Constructs a Trigger instance around the right trigger 2 button's digital signal.
      Returns:
      a Trigger instance representing the right trigger 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:

    • R2

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

    • create

      public Trigger create()
      Constructs a Trigger instance around the create button's digital signal.
      Returns:
      a Trigger instance representing the create 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:

    • create

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

    • options

      public Trigger options()
      Constructs a Trigger instance around the options button's digital signal.
      Returns:
      a Trigger instance representing the options 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:

    • options

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

    • L3

      public Trigger L3()
      Constructs a Trigger instance around the L3 (left stick) button's digital signal.
      Returns:
      a Trigger instance representing the L3 (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:

    • L3

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

    • R3

      public Trigger R3()
      Constructs a Trigger instance around the R3 (right stick) button's digital signal.
      Returns:
      a Trigger instance representing the R3 (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:

    • R3

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

    • PS

      public Trigger PS()
      Constructs a Trigger instance around the PlayStation button's digital signal.
      Returns:
      a Trigger instance representing the PlayStation 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:

    • PS

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

    • touchpad

      public Trigger touchpad()
      Constructs a Trigger instance around the touchpad button's digital signal.
      Returns:
      a Trigger instance representing the 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:

    • touchpad

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

    • getLeftX

      public double getLeftX()
      Get the X axis value of left side of the controller. Right is positive.
      Returns:
      The axis value.

    • getLeftY

      public double getLeftY()
      Get the Y axis value of left side of the controller. Back is positive.
      Returns:
      The axis value.

    • getRightX

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

    • getRightY

      public double getRightY()
      Get the Y axis value of right side of the controller. Back is positive.
      Returns:
      The axis value.

    • getL2Axis

      public double getL2Axis()
      Get the left trigger 2 axis value of the controller. Note that this axis is bound to the range of [0, 1] as opposed to the usual [-1, 1].
      Returns:
      The axis value.

    • getR2Axis

      public double getR2Axis()
      Get the right trigger 2 axis value of the controller. Note that this axis is bound to the range of [0, 1] as opposed to the usual [-1, 1].
      Returns:
      The axis value.