button.rst

Buttons

There are two buttons on the board, called button_a and button_b.

Attributes

.. py:attribute:: button_a

    A ``Button`` instance (see below) representing the left button.

.. py:attribute:: button_b

    Represents the right button.

Classes

.. py:class:: Button()

    Represents a button.

    .. note::
        This class is not actually available to the user, it is only used by
        the two button instances, which are provided already initialized.


    .. py:method:: is_pressed()

        Returns ``True`` if the specified button ``button`` is pressed, and
        ``False`` otherwise.

    .. py:method:: was_pressed()

        Returns ``True`` or ``False`` to indicate if the button was pressed
        since the device started or the last time this method was called.

    .. py:method:: get_presses()

        Returns the running total of button presses.

    .. py:method:: reset_presses()

        Resets the running total of button presses to zero.

Example

import microbit

while True:
    if microbit.button_a.is_pressed() and microbit.button_b.is_pressed():
        microbit.display.scroll("AB")
        break
    elif microbit.button_a.is_pressed():
        microbit.display.scroll("A")
    elif microbit.button_b.is_pressed():
        microbit.display.scroll("B")
    microbit.sleep(100)