Merge pull request #82 from deshipu/microbit-docs

Add documentation for the base microbit module
bbcmicrobit · Nov 8, 2015 · 56a388c · 56a388c · dpgeorge · Nov 8, 2015
2 parents cc43018 + 4c3357c
commit 56a388c
Show file tree

Hide file tree

Showing 2 changed files with 79 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,7 @@ Contents:
 
    api_design_heuristics.rst
    microbit_micropython_api.rst
+   microbit.rst
    music_api.rst
    compass.rst
 

diff --git a/docs/microbit.rst b/docs/microbit.rst
@@ -0,0 +1,78 @@
+Microbit Module
+***************
+
+.. py::module:: microbit
+
+
+The ``microbit`` module gives you access to all the hardware that is built-in
+into your board.
+
+
+Functions
+=========
+
+.. py:function:: panic()
+
+    Enter a panic mode. Requires restart.
+
+
+.. py:function:: reset()
+
+    Restart the board.
+
+
+.. py:function:: sleep(n)
+
+    Wait for ``n`` milliseconds. One second is 1000 milliseconds, so::
+
+        microbit.sleep(1000)
+
+    will pause the execution for one second.
+
+
+.. py:function:: random(n)
+
+    Generate a pseudo-random number between 0 and ``n``-1. For instance::
+
+        result = microbit.random(6) + 1
+
+    will simulate a roll of a six-sided die, giving numbers from 1 to 6
+    inclusive.
+
+
+.. py:function:: running_time()
+
+    Return the number of milliseconds since the board was switched on or
+    restarted.
+
+
+Attributes
+==========
+
+.. toctree::
+    :maxdepth: 1
+    button.rst
+    pin.rst
+
+
+Classes
+=======
+
+.. toctree::
+    :maxdepth: 1
+
+    image.rst
+
+
+Modules
+=======
+
+.. toctree::
+    :maxdepth: 1
+
+    display.rst
+    music_api.rst
+    uart.rst
+    i2c.rst
+    accelerometer.rst
+    compass.rst