SteamController

class wpilib.SteamController(*args, **kwargs)

Bases: HIDDevice, Sendable

Handle input from Steam controllers connected to the Driver Station.

This class handles Steam input that comes from the Driver Station. Each time a value is requested the most recent value is returned.

Overloaded function.

  1. __init__(self: wpilib._wpilib.SteamController, port: typing.SupportsInt | typing.SupportsIndex) -> None

Construct an instance of a controller.

The controller index is the USB port on the Driver Station.

Parameters:

port – The port on the Driver Station that the controller is plugged into.

  1. __init__(self: wpilib._wpilib.SteamController, hid: wpilib._wpilib.GenericHID) -> None

Construct an instance of a controller with a GenericHID object.

Parameters:

hid – The GenericHID object to use for this controller.

class Axis(value: SupportsInt | SupportsIndex)

Bases: pybind11_object

Represents an axis on a SteamController.

Members:

LEFT_X : Left X.

LEFT_Y : Left Y.

RIGHT_X : Right X.

RIGHT_Y : Right Y.

LEFT_TRIGGER : Left Trigger.

RIGHT_TRIGGER : Right Trigger.

LEFT_TRIGGER = <Axis.LEFT_TRIGGER: 4>
LEFT_X = <Axis.LEFT_X: 0>
LEFT_Y = <Axis.LEFT_Y: 1>
RIGHT_TRIGGER = <Axis.RIGHT_TRIGGER: 5>
RIGHT_X = <Axis.RIGHT_X: 2>
RIGHT_Y = <Axis.RIGHT_Y: 3>
SteamController.Axis.name -> str
property value
class Button(value: SupportsInt | SupportsIndex)

Bases: pybind11_object

Represents a digital button on a SteamController.

Members:

A : A button.

B : B button.

X : X button.

Y : Y button.

MENU : Menu button.

STEAM : Steam button.

VIEW : View button.

LEFT_STICK : Left Stick button.

RIGHT_STICK : Right Stick button.

LEFT_BUMPER : Left Bumper button.

RIGHT_BUMPER : Right Bumper button.

DPAD_UP : Dpad Up button.

DPAD_DOWN : Dpad Down button.

DPAD_LEFT : Dpad Left button.

DPAD_RIGHT : Dpad Right button.

QAM : QAM button.

RIGHT_PADDLE_1 : Right Paddle 1 button.

LEFT_PADDLE_1 : Left Paddle 1 button.

RIGHT_PADDLE_2 : Right Paddle 2 button.

LEFT_PADDLE_2 : Left Paddle 2 button.

LEFT_TOUCHPAD : Left Touchpad button.

RIGHT_TOUCHPAD : Right Touchpad button.

LEFT_STICK_TOUCH : Left Stick Touch button.

RIGHT_STICK_TOUCH : Right Stick Touch button.

LEFT_GRIP_TOUCH : Left Grip Touch button.

RIGHT_GRIP_TOUCH : Right Grip Touch button.

A = <Button.A: 0>
B = <Button.B: 1>
DPAD_DOWN = <Button.DPAD_DOWN: 12>
DPAD_LEFT = <Button.DPAD_LEFT: 13>
DPAD_RIGHT = <Button.DPAD_RIGHT: 14>
DPAD_UP = <Button.DPAD_UP: 11>
LEFT_BUMPER = <Button.LEFT_BUMPER: 9>
LEFT_GRIP_TOUCH = <Button.LEFT_GRIP_TOUCH: 24>
LEFT_PADDLE_1 = <Button.LEFT_PADDLE_1: 17>
LEFT_PADDLE_2 = <Button.LEFT_PADDLE_2: 19>
LEFT_STICK = <Button.LEFT_STICK: 7>
LEFT_STICK_TOUCH = <Button.LEFT_STICK_TOUCH: 22>
LEFT_TOUCHPAD = <Button.LEFT_TOUCHPAD: 20>
MENU = <Button.MENU: 4>
QAM = <Button.QAM: 15>
RIGHT_BUMPER = <Button.RIGHT_BUMPER: 10>
RIGHT_GRIP_TOUCH = <Button.RIGHT_GRIP_TOUCH: 25>
RIGHT_PADDLE_1 = <Button.RIGHT_PADDLE_1: 16>
RIGHT_PADDLE_2 = <Button.RIGHT_PADDLE_2: 18>
RIGHT_STICK = <Button.RIGHT_STICK: 8>
RIGHT_STICK_TOUCH = <Button.RIGHT_STICK_TOUCH: 23>
RIGHT_TOUCHPAD = <Button.RIGHT_TOUCHPAD: 21>
STEAM = <Button.STEAM: 5>
VIEW = <Button.VIEW: 6>
X = <Button.X: 2>
Y = <Button.Y: 3>
SteamController.Button.name -> str
property value
SUPPORTED_OUTPUTS = <SupportedOutputs.RUMBLE: 8>
SUPPORTS_MONO_LED = False
SUPPORTS_RGB_LED = False
SUPPORTS_RUMBLE = True
SUPPORTS_TRIGGER_RUMBLE = False
TOUCHPAD_COUNT = 2
a(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the A button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the A button’s digital signal attached to the given loop.

axis_greater_than(axis: wpilib._wpilib.SteamController.Axis, threshold: SupportsFloat | SupportsIndex, loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance that is true when the axis value is greater than threshold.

Parameters:
  • axis – The axis to read.

  • threshold – The value above which this event should return true.

  • loop – the event loop instance to attach the event to.

Returns:

an event instance that is true when the axis value is greater than the provided threshold.

axis_less_than(axis: wpilib._wpilib.SteamController.Axis, threshold: SupportsFloat | SupportsIndex, loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance that is true when the axis value is less than threshold.

Parameters:
  • axis – The axis to read.

  • threshold – The value below which this event should return true.

  • loop – the event loop instance to attach the event to.

Returns:

an event instance that is true when the axis value is less than the provided threshold.

b(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the B button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the B button’s digital signal attached to the given loop.

button(button: wpilib._wpilib.SteamController.Button, loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around this button’s digital signal.

Parameters:
  • button – the button

  • loop – the event loop instance to attach the event to.

Returns:

an event instance representing the button’s digital signal attached to the given loop.

dpad_down(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Dpad Down button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Dpad Down button’s digital signal attached to the given loop.

dpad_left(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Dpad Left button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Dpad Left button’s digital signal attached to the given loop.

dpad_right(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Dpad Right button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Dpad Right button’s digital signal attached to the given loop.

dpad_up(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Dpad Up button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Dpad Up button’s digital signal attached to the given loop.

get_a_button() bool

Read the value of the A button on the controller.

Returns:

The state of the button.

get_a_button_pressed() bool

Whether the A button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_a_button_released() bool

Whether the A button was released since the last check.

Returns:

Whether the button was released since the last check.

get_axis(axis: wpilib._wpilib.SteamController.Axis) float

Get the value of the axis.

Parameters:

axis – The axis to read

Returns:

the axis value.

get_b_button() bool

Read the value of the B button on the controller.

Returns:

The state of the button.

get_b_button_pressed() bool

Whether the B button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_b_button_released() bool

Whether the B button was released since the last check.

Returns:

Whether the button was released since the last check.

get_button(button: wpilib._wpilib.SteamController.Button) bool

Get the button value.

Parameters:

button – The button to read

Returns:

The state of the button.

get_button_pressed(button: wpilib._wpilib.SteamController.Button) bool

Whether the button was pressed since the last check.

Parameters:

button – The button to read

Returns:

Whether the button was pressed since the last check.

get_button_released(button: wpilib._wpilib.SteamController.Button) bool

Whether the button was released since the last check.

Parameters:

button – The button to read

Returns:

Whether the button was released since the last check.

get_dpad_down_button() bool

Read the value of the Dpad Down button on the controller.

Returns:

The state of the button.

get_dpad_down_button_pressed() bool

Whether the Dpad Down button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_dpad_down_button_released() bool

Whether the Dpad Down button was released since the last check.

Returns:

Whether the button was released since the last check.

get_dpad_left_button() bool

Read the value of the Dpad Left button on the controller.

Returns:

The state of the button.

get_dpad_left_button_pressed() bool

Whether the Dpad Left button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_dpad_left_button_released() bool

Whether the Dpad Left button was released since the last check.

Returns:

Whether the button was released since the last check.

get_dpad_right_button() bool

Read the value of the Dpad Right button on the controller.

Returns:

The state of the button.

get_dpad_right_button_pressed() bool

Whether the Dpad Right button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_dpad_right_button_released() bool

Whether the Dpad Right button was released since the last check.

Returns:

Whether the button was released since the last check.

get_dpad_up_button() bool

Read the value of the Dpad Up button on the controller.

Returns:

The state of the button.

get_dpad_up_button_pressed() bool

Whether the Dpad Up button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_dpad_up_button_released() bool

Whether the Dpad Up button was released since the last check.

Returns:

Whether the button was released since the last check.

get_hid() wpilib._wpilib.GenericHID

Get the underlying GenericHID object.

Returns:

the wrapped GenericHID object

get_left_bumper_button() bool

Read the value of the Left Bumper button on the controller.

Returns:

The state of the button.

get_left_bumper_button_pressed() bool

Whether the Left Bumper button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_bumper_button_released() bool

Whether the Left Bumper button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_grip_touch_button() bool

Read the value of the Left Grip Touch button on the controller.

Returns:

The state of the button.

get_left_grip_touch_button_pressed() bool

Whether the Left Grip Touch button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_grip_touch_button_released() bool

Whether the Left Grip Touch button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_paddle1_button() bool

Read the value of the Left Paddle 1 button on the controller.

Returns:

The state of the button.

get_left_paddle1_button_pressed() bool

Whether the Left Paddle 1 button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_paddle1_button_released() bool

Whether the Left Paddle 1 button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_paddle2_button() bool

Read the value of the Left Paddle 2 button on the controller.

Returns:

The state of the button.

get_left_paddle2_button_pressed() bool

Whether the Left Paddle 2 button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_paddle2_button_released() bool

Whether the Left Paddle 2 button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_stick_button() bool

Read the value of the Left Stick button on the controller.

Returns:

The state of the button.

get_left_stick_button_pressed() bool

Whether the Left Stick button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_stick_button_released() bool

Whether the Left Stick button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_stick_touch_button() bool

Read the value of the Left Stick Touch button on the controller.

Returns:

The state of the button.

get_left_stick_touch_button_pressed() bool

Whether the Left Stick Touch button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_stick_touch_button_released() bool

Whether the Left Stick Touch button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_touchpad_button() bool

Read the value of the Left Touchpad button on the controller.

Returns:

The state of the button.

get_left_touchpad_button_pressed() bool

Whether the Left Touchpad button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_left_touchpad_button_released() bool

Whether the Left Touchpad button was released since the last check.

Returns:

Whether the button was released since the last check.

get_left_trigger() float

Get the Left Trigger value of the controller.

Returns:

the axis value.

get_left_x() float

Get the Left X value of the controller.

Returns:

the axis value.

get_left_y() float

Get the Left Y value of the controller.

Returns:

the axis value.

get_menu_button() bool

Read the value of the Menu button on the controller.

Returns:

The state of the button.

get_menu_button_pressed() bool

Whether the Menu button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_menu_button_released() bool

Whether the Menu button was released since the last check.

Returns:

Whether the button was released since the last check.

get_port() int

Get the port number of the HID.

Returns:

The port number of the HID.

get_qam_button() bool

Read the value of the QAM button on the controller.

Returns:

The state of the button.

get_qam_button_pressed() bool

Whether the QAM button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_qam_button_released() bool

Whether the QAM button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_bumper_button() bool

Read the value of the Right Bumper button on the controller.

Returns:

The state of the button.

get_right_bumper_button_pressed() bool

Whether the Right Bumper button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_bumper_button_released() bool

Whether the Right Bumper button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_grip_touch_button() bool

Read the value of the Right Grip Touch button on the controller.

Returns:

The state of the button.

get_right_grip_touch_button_pressed() bool

Whether the Right Grip Touch button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_grip_touch_button_released() bool

Whether the Right Grip Touch button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_paddle1_button() bool

Read the value of the Right Paddle 1 button on the controller.

Returns:

The state of the button.

get_right_paddle1_button_pressed() bool

Whether the Right Paddle 1 button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_paddle1_button_released() bool

Whether the Right Paddle 1 button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_paddle2_button() bool

Read the value of the Right Paddle 2 button on the controller.

Returns:

The state of the button.

get_right_paddle2_button_pressed() bool

Whether the Right Paddle 2 button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_paddle2_button_released() bool

Whether the Right Paddle 2 button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_stick_button() bool

Read the value of the Right Stick button on the controller.

Returns:

The state of the button.

get_right_stick_button_pressed() bool

Whether the Right Stick button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_stick_button_released() bool

Whether the Right Stick button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_stick_touch_button() bool

Read the value of the Right Stick Touch button on the controller.

Returns:

The state of the button.

get_right_stick_touch_button_pressed() bool

Whether the Right Stick Touch button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_stick_touch_button_released() bool

Whether the Right Stick Touch button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_touchpad_button() bool

Read the value of the Right Touchpad button on the controller.

Returns:

The state of the button.

get_right_touchpad_button_pressed() bool

Whether the Right Touchpad button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_right_touchpad_button_released() bool

Whether the Right Touchpad button was released since the last check.

Returns:

Whether the button was released since the last check.

get_right_trigger() float

Get the Right Trigger value of the controller.

Returns:

the axis value.

get_right_x() float

Get the Right X value of the controller.

Returns:

the axis value.

get_right_y() float

Get the Right Y value of the controller.

Returns:

the axis value.

get_steam_button() bool

Read the value of the Steam button on the controller.

Returns:

The state of the button.

get_steam_button_pressed() bool

Whether the Steam button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_steam_button_released() bool

Whether the Steam button was released since the last check.

Returns:

Whether the button was released since the last check.

get_touchpad_finger(touchpad: SupportsInt | SupportsIndex, finger: SupportsInt | SupportsIndex) wpilib._wpilib.TouchpadFinger

Get the touchpad finger data.

Parameters:
  • touchpad – The touchpad to read.

  • finger – The finger to read.

Returns:

The touchpad finger data.

get_touchpad_finger_available(touchpad: SupportsInt | SupportsIndex, finger: SupportsInt | SupportsIndex) bool

Check if a touchpad finger is available.

Parameters:
  • touchpad – The touchpad to check.

  • finger – The finger to check.

Returns:

true if the touchpad finger is available.

get_view_button() bool

Read the value of the View button on the controller.

Returns:

The state of the button.

get_view_button_pressed() bool

Whether the View button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_view_button_released() bool

Whether the View button was released since the last check.

Returns:

Whether the button was released since the last check.

get_x_button() bool

Read the value of the X button on the controller.

Returns:

The state of the button.

get_x_button_pressed() bool

Whether the X button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_x_button_released() bool

Whether the X button was released since the last check.

Returns:

Whether the button was released since the last check.

get_y_button() bool

Read the value of the Y button on the controller.

Returns:

The state of the button.

get_y_button_pressed() bool

Whether the Y button was pressed since the last check.

Returns:

Whether the button was pressed since the last check.

get_y_button_released() bool

Whether the Y button was released since the last check.

Returns:

Whether the button was released since the last check.

init_sendable(builder: wpiutil._wpiutil.SendableBuilder) None
is_connected() bool

Get if the HID is connected.

Returns:

true if the HID is connected

left_bumper(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Bumper button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Bumper button’s digital signal attached to the given loop.

left_grip_touch(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Grip Touch button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Grip Touch button’s digital signal attached to the given loop.

left_paddle1(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Paddle 1 button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Paddle 1 button’s digital signal attached to the given loop.

left_paddle2(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Paddle 2 button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Paddle 2 button’s digital signal attached to the given loop.

left_stick(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Stick button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Stick button’s digital signal attached to the given loop.

left_stick_touch(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Stick Touch button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Stick Touch button’s digital signal attached to the given loop.

left_touchpad(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Left Touchpad button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Left Touchpad button’s digital signal attached to the given loop.

menu(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Menu button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Menu button’s digital signal attached to the given loop.

qam(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the QAM button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the QAM button’s digital signal attached to the given loop.

right_bumper(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Bumper button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Bumper button’s digital signal attached to the given loop.

right_grip_touch(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Grip Touch button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Grip Touch button’s digital signal attached to the given loop.

right_paddle1(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Paddle 1 button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Paddle 1 button’s digital signal attached to the given loop.

right_paddle2(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Paddle 2 button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Paddle 2 button’s digital signal attached to the given loop.

right_stick(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Stick button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Stick button’s digital signal attached to the given loop.

right_stick_touch(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Stick Touch button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Stick Touch button’s digital signal attached to the given loop.

right_touchpad(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Right Touchpad button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Right Touchpad button’s digital signal attached to the given loop.

set_leds(r: SupportsInt | SupportsIndex, g: SupportsInt | SupportsIndex, b: SupportsInt | SupportsIndex) None

Set leds on the controller.

Parameters:
  • r – Red value from 0-255

  • g – Green value from 0-255

  • b – Blue value from 0-255

set_rumble(type: wpilib._wpilib.GenericHID.RumbleType, value: SupportsFloat | SupportsIndex) None

Set the rumble output for the HID.

Parameters:
  • type – Which rumble value to set

  • value – The normalized value (0 to 1) to set the rumble to

steam(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Steam button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Steam button’s digital signal attached to the given loop.

view(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the View button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the View button’s digital signal attached to the given loop.

x(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the X button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the X button’s digital signal attached to the given loop.

y(loop: wpilib._wpilib.EventLoop) wpilib._wpilib.BooleanEvent

Constructs an event instance around the Y button’s digital signal.

Parameters:

loop – the event loop instance to attach the event to.

Returns:

an event instance representing the Y button’s digital signal attached to the given loop.