aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/api/waitforbuttonpress.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/lang/api/waitforbuttonpress.rst')
-rw-r--r--docs/source/lang/api/waitforbuttonpress.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/source/lang/api/waitforbuttonpress.rst b/docs/source/lang/api/waitforbuttonpress.rst
new file mode 100644
index 0000000..34c5066
--- /dev/null
+++ b/docs/source/lang/api/waitforbuttonpress.rst
@@ -0,0 +1,17 @@
+.. _lang-waitforbuttonpress:
+
+waitForButtonPress()
+====================
+
+Wait for the board's built-in button (labeled BUT on the silkscreen)
+to be pressed, possibly with timeout.
+
+Library Documentation
+---------------------
+
+.. doxygenfunction:: waitForButtonPress
+
+See Also
+--------
+
+- :ref:`lang-isbuttonpressed`