aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/isbuttonpressed.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api/isbuttonpressed.rst')
-rw-r--r--docs/source/lang/api/isbuttonpressed.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/source/lang/api/isbuttonpressed.rst b/docs/source/lang/api/isbuttonpressed.rst
new file mode 100644
index 0000000..8c350b9
--- /dev/null
+++ b/docs/source/lang/api/isbuttonpressed.rst
@@ -0,0 +1,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`