hub.button

The button module includes functions to interact with the buttons on the Spike hub.

To use the button module, add the following import statement to your project:

from hub import button

All functions in the module should be called inside the button module as a prefix like so:

button.pressed(button.LEFT)

The following constants are defined:

• LEFT = 0 (differs from official docs)

• POWER = 1 (UNDOCUMENTED)

• RIGHT = 2

• CONNECT = 3 (UNDOCUMENTED)

Functions

pressed(button)

This module allows you to react to buttons being pressed on the hub.

hub.button.pressed(button)

This module allows you to react to buttons being pressed on the hub. You must first import the button module to use the buttons.

from hub import button

left_button_press_duration = 0

# Wait for the left button to be pressed
while not button.pressed(button.LEFT):
    pass

# As long as the left button is being pressed, update the
# `left_button_press_duration` variable
while button.pressed(button.LEFT):
    left_button_press_duration = button.pressed(button.LEFT)

print("Left button was pressed for " + str(left_button_press_duration)
    + " milliseconds")

Parameters:

button (int) – A button from the button submodule in the hub module

Return type:

int