# THIS FILE WAS AUTO-GENERATED BY ./commandsv2/generate_hids.py. DO NOT MODIFY
from typing import Optional, Union
from wpilib import EventLoop, Switch2ProController
from .commandgenerichid import CommandGenericHID
from .trigger import Trigger
[docs]
class CommandSwitch2ProController:
"""
A version of :class:`wpilib.Switch2ProController` with :class:`.Trigger` factories for command-based.
"""
_hid: CommandGenericHID
_controller: Switch2ProController
def __init__(self, hid: Union[int, Switch2ProController]):
"""
Construct an instance of a controller.
:param hid: The port index on the Driver Station that the controller is plugged into,
or the Switch2ProController object to use for this controller.
"""
if isinstance(hid, int):
self._hid = CommandGenericHID.get_command_generic_hid(hid)
self._controller = Switch2ProController(self._hid.get_hid())
else:
self._hid = CommandGenericHID(hid.get_hid())
self._controller = hid
[docs]
def get_hid(self) -> CommandGenericHID:
"""
Get the underlying CommandGenericHID object.
:returns: the wrapped CommandGenericHID object
"""
return self._hid
[docs]
def get_controller(self) -> Switch2ProController:
"""
Get the wrapped controller object.
:returns: the wrapped controller object
"""
return self._controller
[docs]
def b(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the B button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the B button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.B, loop)
[docs]
def a(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the A button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the A button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.A, loop)
[docs]
def y(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Y button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Y button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.Y, loop)
[docs]
def x(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the X button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the X button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.X, loop)
[docs]
def minus(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Minus button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Minus button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.MINUS, loop)
[docs]
def home(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Home button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Home button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.HOME, loop)
[docs]
def plus(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Plus button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Plus button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.PLUS, loop)
[docs]
def left_stick(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Left Stick button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Left Stick button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.LEFT_STICK, loop)
[docs]
def right_stick(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Right Stick button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Right Stick button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.RIGHT_STICK, loop)
[docs]
def l(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the L button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the L button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.L, loop)
[docs]
def r(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the R button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the R button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.R, loop)
[docs]
def dpad_up(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Dpad Up button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Dpad Up button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.DPAD_UP, loop)
[docs]
def dpad_down(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Dpad Down button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Dpad Down button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.DPAD_DOWN, loop)
[docs]
def dpad_left(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Dpad Left button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Dpad Left button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.DPAD_LEFT, loop)
[docs]
def dpad_right(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Dpad Right button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Dpad Right button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.DPAD_RIGHT, loop)
[docs]
def capture(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the Capture button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the Capture button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.CAPTURE, loop)
[docs]
def gr(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the GR button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the GR button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.GR, loop)
[docs]
def gl(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the GL button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the GL button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.GL, loop)
[docs]
def c(self, loop: Optional[EventLoop] = None) -> Trigger:
"""
Constructs a Trigger instance around the C button's digital signal.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance representing the C button's digital signal
attached to the given loop.
"""
return self.button(Switch2ProController.Button.C, loop)
[docs]
def zl(
self,
threshold: float = 0.5,
loop: Optional[EventLoop] = None,
) -> Trigger:
"""
Constructs a Trigger instance around the ZL axis value. The returned
Trigger will be true when the axis value is greater than ``threshold``.
:param 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.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance that is true when the ZL axis exceeds the
provided threshold, attached to the given event loop.
"""
return self.axis_greater_than(
Switch2ProController.Axis.ZL,
threshold,
loop,
)
[docs]
def zr(
self,
threshold: float = 0.5,
loop: Optional[EventLoop] = None,
) -> Trigger:
"""
Constructs a Trigger instance around the ZR axis value. The returned
Trigger will be true when the axis value is greater than ``threshold``.
:param 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.
:param loop: the event loop instance to attach the Trigger to, defaults
to :func:`commands2.CommandScheduler.get_default_button_loop`
:returns: a Trigger instance that is true when the ZR axis exceeds the
provided threshold, attached to the given event loop.
"""
return self.axis_greater_than(
Switch2ProController.Axis.ZR,
threshold,
loop,
)
[docs]
def axis_less_than(
self,
axis: Switch2ProController.Axis,
threshold: float,
loop: Optional[EventLoop] = None,
) -> Trigger:
"""
Constructs a Trigger instance that is true when the axis value is less than
``threshold``, attached to the given loop.
:param axis: the :class:`wpilib.Switch2ProController.Axis` to read
:param threshold: the value below which this Trigger should return true.
:param loop: the event loop instance to attach the Trigger to
:returns: a Trigger instance that is true when the axis value is less than
the provided threshold.
"""
return self._hid.axis_less_than(axis.value, threshold, loop)
[docs]
def axis_greater_than(
self,
axis: Switch2ProController.Axis,
threshold: float,
loop: Optional[EventLoop] = None,
) -> Trigger:
"""
Constructs a Trigger instance that is true when the axis value is greater
than ``threshold``, attached to the given loop.
:param axis: the :class:`wpilib.Switch2ProController.Axis` to read
:param threshold: the value above which this Trigger should return true.
:param loop: the event loop instance to attach the Trigger to.
:returns: a Trigger instance that is true when the axis value is greater
than the provided threshold.
"""
return self._hid.axis_greater_than(axis.value, threshold, loop)
[docs]
def axis_magnitude_greater_than(
self,
axis: Switch2ProController.Axis,
threshold: float,
loop: Optional[EventLoop] = None,
) -> Trigger:
"""
Constructs a Trigger instance that is true when the axis magnitude is
greater than ``threshold``, attached to the given loop.
:param axis: the :class:`wpilib.Switch2ProController.Axis` to read
:param threshold: the value above which this Trigger should return true.
:param loop: the event loop instance to attach the Trigger to.
:returns: a Trigger instance that is true when the axis magnitude is
greater than the provided threshold.
"""
return self._hid.axis_magnitude_greater_than(axis.value, threshold, loop)
[docs]
def get_axis(self, axis: Switch2ProController.Axis) -> float:
"""
Get the value of the axis.
:param axis: the :class:`wpilib.Switch2ProController.Axis` to read
"""
return self._hid.get_raw_axis(axis.value)
[docs]
def get_left_x(self) -> float:
"""
Get the Left X value of the controller.
:returns: the axis value.
"""
return self._controller.get_left_x()
[docs]
def get_left_y(self) -> float:
"""
Get the Left Y value of the controller.
:returns: the axis value.
"""
return self._controller.get_left_y()
[docs]
def get_right_x(self) -> float:
"""
Get the Right X value of the controller.
:returns: the axis value.
"""
return self._controller.get_right_x()
[docs]
def get_right_y(self) -> float:
"""
Get the Right Y value of the controller.
:returns: the axis value.
"""
return self._controller.get_right_y()
[docs]
def get_zl(self) -> float:
"""
Get the ZL value of the controller.
:returns: the axis value.
"""
return self._controller.get_zl()
[docs]
def get_zr(self) -> float:
"""
Get the ZR value of the controller.
:returns: the axis value.
"""
return self._controller.get_zr()