summaryrefslogtreecommitdiff
path: root/docs/library/wipy.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/wipy.rst')
-rw-r--r--docs/library/wipy.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/library/wipy.rst b/docs/library/wipy.rst
new file mode 100644
index 000000000..66aecd053
--- /dev/null
+++ b/docs/library/wipy.rst
@@ -0,0 +1,15 @@
+:mod:`wipy` -- WiPy specific features
+=====================================
+
+.. module:: wipy
+ :synopsis: WiPy specific features
+
+The ``wipy`` module contains functions to control specific features of the
+WiPy, such as the heartbeat LED.
+
+Functions
+---------
+
+.. function:: heartbeat([enable])
+
+ Get or set the state (enabled or disabled) of the heartbeat LED.