aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/isbuttonpressed.rst
blob: 8c350b9fabf1df0af470448a15ebe2ce8fa13152 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
.. _lang-isbuttonpressed:

isButtonPressed()
=================

Check whether the board's built-in button (labeled BUT on the
silkscreen) is pressed.  The pin number of the built-in button is
given by the constant ``BOARD_BUTTON_PIN``.

Library Documentation
---------------------

.. doxygenfunction:: isButtonPressed

See Also
--------

- :ref:`Board-specific values <lang-board-values>`
- :ref:`BOARD_BUTTON_PIN <lang-board-values-but>`
- :ref:`lang-waitforbuttonpress`