Documentation/pycardium/color.rst

@@ -9,14 +9,633 @@ Color Class
 
 Constants
 ---------
-
 The color module also contains a few constanst for commonly used colors:
 
-.. py:data:: color.BLACK
-.. py:data:: color.WHITE
-.. py:data:: color.RED
-.. py:data:: color.GREEN
-.. py:data:: color.YELLOW
-.. py:data:: color.BLUE
-.. py:data:: color.MAGENTA
-.. py:data:: color.CYAN
+Camp Colors
+~~~~~~~~~~~
+.. py:data:: CHAOSBLUE
+
+   .. color-example:: #0076BA
+
+.. py:data:: CHAOSBLUE_DARK
+
+   .. color-example:: #005383
+
+.. py:data:: COMMYELLOW
+
+   .. color-example:: #FFC600
+
+.. py:data:: COMMYELLOW_DARK
+
+   .. color-example:: #D39A00
+
+.. py:data:: CAMPGREEN
+
+   .. color-example:: #99BA00
+
+.. py:data:: CAMPGREEN_DARK
+
+   .. color-example:: #6F8700
+
+
+General
+~~~~~~~
+.. py:data:: BLACK
+
+   .. color-example:: #000
+
+.. py:data:: WHITE
+
+   .. color-example:: #fff
+
+.. py:data:: RED
+
+   .. color-example:: #f00
+
+.. py:data:: GREEN
+
+   .. color-example:: #0f0
+
+.. py:data:: YELLOW
+
+   .. color-example:: #ff0
+
+.. py:data:: BLUE
+
+   .. color-example:: #00f
+
+.. py:data:: MAGENTA
+
+   .. color-example:: #f0f
+
+.. py:data:: CYAN
+
+   .. color-example:: #0ff
+
+
+.. py:module:: htmlcolor
+
+``htmlcolor`` - Color Constants
+===============================
+The ``htmlcolor`` module contains even more color constants.  Note
+that loading the ``htmlcolor`` module will require ~12K of RAM.
+
+.. py:data:: ALICEBLUE
+
+   .. color-example:: aliceblue
+
+.. py:data:: ANTIQUEWHITE
+
+   .. color-example:: antiquewhite
+
+.. py:data:: AQUA
+
+   .. color-example:: aqua
+
+.. py:data:: AQUAMARINE
+
+   .. color-example:: aquamarine
+
+.. py:data:: AZURE
+
+   .. color-example:: azure
+
+.. py:data:: BEIGE
+
+   .. color-example:: beige
+
+.. py:data:: BISQUE
+
+   .. color-example:: bisque
+
+.. py:data:: BLACK
+
+   .. color-example:: black
+
+.. py:data:: BLANCHEDALMOND
+
+   .. color-example:: blanchedalmond
+
+.. py:data:: BLUE
+
+   .. color-example:: blue
+
+.. py:data:: BLUEVIOLET
+
+   .. color-example:: blueviolet
+
+.. py:data:: BROWN
+
+   .. color-example:: brown
+
+.. py:data:: BURLYWOOD
+
+   .. color-example:: burlywood
+
+.. py:data:: CADETBLUE
+
+   .. color-example:: cadetblue
+
+.. py:data:: CHARTREUSE
+
+   .. color-example:: chartreuse
+
+.. py:data:: CHOCOLATE
+
+   .. color-example:: chocolate
+
+.. py:data:: CORAL
+
+   .. color-example:: coral
+
+.. py:data:: CORNFLOWERBLUE
+
+   .. color-example:: cornflowerblue
+
+.. py:data:: CORNSILK
+
+   .. color-example:: cornsilk
+
+.. py:data:: CRIMSON
+
+   .. color-example:: crimson
+
+.. py:data:: CYAN
+
+   .. color-example:: cyan
+
+.. py:data:: DARKBLUE
+
+   .. color-example:: darkblue
+
+.. py:data:: DARKCYAN
+
+   .. color-example:: darkcyan
+
+.. py:data:: DARKGOLDENROD
+
+   .. color-example:: darkgoldenrod
+
+.. py:data:: DARKGRAY
+
+   .. color-example:: darkgray
+
+.. py:data:: DARKGREEN
+
+   .. color-example:: darkgreen
+
+.. py:data:: DARKKHAKI
+
+   .. color-example:: darkkhaki
+
+.. py:data:: DARKMAGENTA
+
+   .. color-example:: darkmagenta
+
+.. py:data:: DARKOLIVEGREEN
+
+   .. color-example:: darkolivegreen
+
+.. py:data:: DARKORANGE
+
+   .. color-example:: darkorange
+
+.. py:data:: DARKORCHID
+
+   .. color-example:: darkorchid
+
+.. py:data:: DARKRED
+
+   .. color-example:: darkred
+
+.. py:data:: DARKSALMON
+
+   .. color-example:: darksalmon
+
+.. py:data:: DARKSEAGREEN
+
+   .. color-example:: darkseagreen
+
+.. py:data:: DARKSLATEBLUE
+
+   .. color-example:: darkslateblue
+
+.. py:data:: DARKSLATEGRAY
+
+   .. color-example:: darkslategray
+
+.. py:data:: DARKTURQUOISE
+
+   .. color-example:: darkturquoise
+
+.. py:data:: DARKVIOLET
+
+   .. color-example:: darkviolet
+
+.. py:data:: DEEPPINK
+
+   .. color-example:: deeppink
+
+.. py:data:: DEEPSKYBLUE
+
+   .. color-example:: deepskyblue
+
+.. py:data:: DIMGRAY
+
+   .. color-example:: dimgray
+
+.. py:data:: DODGERBLUE
+
+   .. color-example:: dodgerblue
+
+.. py:data:: FIREBRICK
+
+   .. color-example:: firebrick
+
+.. py:data:: FLORALWHITE
+
+   .. color-example:: floralwhite
+
+.. py:data:: FORESTGREEN
+
+   .. color-example:: forestgreen
+
+.. py:data:: FUCHSIA
+
+   .. color-example:: fuchsia
+
+.. py:data:: GAINSBORO
+
+   .. color-example:: gainsboro
+
+.. py:data:: GHOSTWHITE
+
+   .. color-example:: ghostwhite
+
+.. py:data:: GOLD
+
+   .. color-example:: gold
+
+.. py:data:: GOLDENROD
+
+   .. color-example:: goldenrod
+
+.. py:data:: GRAY
+
+   .. color-example:: gray
+
+.. py:data:: GREEN
+
+   .. color-example:: green
+
+.. py:data:: GREENYELLOW
+
+   .. color-example:: greenyellow
+
+.. py:data:: HONEYDEW
+
+   .. color-example:: honeydew
+
+.. py:data:: HOTPINK
+
+   .. color-example:: hotpink
+
+.. py:data:: INDIANRED
+
+   .. color-example:: indianred
+
+.. py:data:: INDIGO
+
+   .. color-example:: indigo
+
+.. py:data:: IVORY
+
+   .. color-example:: ivory
+
+.. py:data:: KHAKI
+
+   .. color-example:: khaki
+
+.. py:data:: LAVENDER
+
+   .. color-example:: lavender
+
+.. py:data:: LAVENDERBLUSH
+
+   .. color-example:: lavenderblush
+
+.. py:data:: LAWNGREEN
+
+   .. color-example:: lawngreen
+
+.. py:data:: LEMONCHIFFON
+
+   .. color-example:: lemonchiffon
+
+.. py:data:: LIGHTBLUE
+
+   .. color-example:: lightblue
+
+.. py:data:: LIGHTCORAL
+
+   .. color-example:: lightcoral
+
+.. py:data:: LIGHTCYAN
+
+   .. color-example:: lightcyan
+
+.. py:data:: LIGHTGOLDENRODYELLOW
+
+   .. color-example:: lightgoldenrodyellow
+
+.. py:data:: LIGHTGRAY
+
+   .. color-example:: lightgray
+
+.. py:data:: LIGHTGREEN
+
+   .. color-example:: lightgreen
+
+.. py:data:: LIGHTPINK
+
+   .. color-example:: lightpink
+
+.. py:data:: LIGHTSALMON
+
+   .. color-example:: lightsalmon
+
+.. py:data:: LIGHTSEAGREEN
+
+   .. color-example:: lightseagreen
+
+.. py:data:: LIGHTSKYBLUE
+
+   .. color-example:: lightskyblue
+
+.. py:data:: LIGHTSLATEGRAY
+
+   .. color-example:: lightslategray
+
+.. py:data:: LIGHTSTEELBLUE
+
+   .. color-example:: lightsteelblue
+
+.. py:data:: LIGHTYELLOW
+
+   .. color-example:: lightyellow
+
+.. py:data:: LIME
+
+   .. color-example:: lime
+
+.. py:data:: LIMEGREEN
+
+   .. color-example:: limegreen
+
+.. py:data:: LINEN
+
+   .. color-example:: linen
+
+.. py:data:: MAGENTA
+
+   .. color-example:: magenta
+
+.. py:data:: MAROON
+
+   .. color-example:: maroon
+
+.. py:data:: MEDIUMAQUAMARINE
+
+   .. color-example:: mediumaquamarine
+
+.. py:data:: MEDIUMBLUE
+
+   .. color-example:: mediumblue
+
+.. py:data:: MEDIUMORCHID
+
+   .. color-example:: mediumorchid
+
+.. py:data:: MEDIUMPURPLE
+
+   .. color-example:: mediumpurple
+
+.. py:data:: MEDIUMSEAGREEN
+
+   .. color-example:: mediumseagreen
+
+.. py:data:: MEDIUMSLATEBLUE
+
+   .. color-example:: mediumslateblue
+
+.. py:data:: MEDIUMSPRINGGREEN
+
+   .. color-example:: mediumspringgreen
+
+.. py:data:: MEDIUMTURQUOISE
+
+   .. color-example:: mediumturquoise
+
+.. py:data:: MEDIUMVIOLETRED
+
+   .. color-example:: mediumvioletred
+
+.. py:data:: MIDNIGHTBLUE
+
+   .. color-example:: midnightblue
+
+.. py:data:: MINTCREAM
+
+   .. color-example:: mintcream
+
+.. py:data:: MISTYROSE
+
+   .. color-example:: mistyrose
+
+.. py:data:: MOCCASIN
+
+   .. color-example:: moccasin
+
+.. py:data:: NAVAJOWHITE
+
+   .. color-example:: navajowhite
+
+.. py:data:: NAVY
+
+   .. color-example:: navy
+
+.. py:data:: OLDLACE
+
+   .. color-example:: oldlace
+
+.. py:data:: OLIVE
+
+   .. color-example:: olive
+
+.. py:data:: OLIVEDRAB
+
+   .. color-example:: olivedrab
+
+.. py:data:: ORANGE
+
+   .. color-example:: orange
+
+.. py:data:: ORANGERED
+
+   .. color-example:: orangered
+
+.. py:data:: ORCHID
+
+   .. color-example:: orchid
+
+.. py:data:: PALEGOLDENROD
+
+   .. color-example:: palegoldenrod
+
+.. py:data:: PALEGREEN
+
+   .. color-example:: palegreen
+
+.. py:data:: PALETURQUOISE
+
+   .. color-example:: paleturquoise
+
+.. py:data:: PALEVIOLETRED
+
+   .. color-example:: palevioletred
+
+.. py:data:: PAPAYAWHIP
+
+   .. color-example:: papayawhip
+
+.. py:data:: PEACHPUFF
+
+   .. color-example:: peachpuff
+
+.. py:data:: PERU
+
+   .. color-example:: peru
+
+.. py:data:: PINK
+
+   .. color-example:: pink
+
+.. py:data:: PLUM
+
+   .. color-example:: plum
+
+.. py:data:: POWDERBLUE
+
+   .. color-example:: powderblue
+
+.. py:data:: PURPLE
+
+   .. color-example:: purple
+
+.. py:data:: RED
+
+   .. color-example:: red
+
+.. py:data:: ROSYBROWN
+
+   .. color-example:: rosybrown
+
+.. py:data:: ROYALBLUE
+
+   .. color-example:: royalblue
+
+.. py:data:: SADDLEBROWN
+
+   .. color-example:: saddlebrown
+
+.. py:data:: SALMON
+
+   .. color-example:: salmon
+
+.. py:data:: SANDYBROWN
+
+   .. color-example:: sandybrown
+
+.. py:data:: SEAGREEN
+
+   .. color-example:: seagreen
+
+.. py:data:: SEASHELL
+
+   .. color-example:: seashell
+
+.. py:data:: SIENNA
+
+   .. color-example:: sienna
+
+.. py:data:: SILVER
+
+   .. color-example:: silver
+
+.. py:data:: SKYBLUE
+
+   .. color-example:: skyblue
+
+.. py:data:: SLATEBLUE
+
+   .. color-example:: slateblue
+
+.. py:data:: SLATEGRAY
+
+   .. color-example:: slategray
+
+.. py:data:: SNOW
+
+   .. color-example:: snow
+
+.. py:data:: SPRINGGREEN
+
+   .. color-example:: springgreen
+
+.. py:data:: STEELBLUE
+
+   .. color-example:: steelblue
+
+.. py:data:: TAN
+
+   .. color-example:: tan
+
+.. py:data:: TEAL
+
+   .. color-example:: teal
+
+.. py:data:: THISTLE
+
+   .. color-example:: thistle
+
+.. py:data:: TOMATO
+
+   .. color-example:: tomato
+
+.. py:data:: TURQUOISE
+
+   .. color-example:: turquoise
+
+.. py:data:: VIOLET
+
+   .. color-example:: violet
+
+.. py:data:: WHEAT
+
+   .. color-example:: wheat
+
+.. py:data:: WHITE
+
+   .. color-example:: white
+
+.. py:data:: WHITESMOKE
+
+   .. color-example:: whitesmoke
+
+.. py:data:: YELLOW
+
+   .. color-example:: yellow
+
+.. py:data:: YELLOWGREEN
+
+   .. color-example:: yellowgreen

Documentation/pycardium/config.rst

+``config`` - Configuration
+==========================
+The ``config`` module provides functions to interact with card10's
+configuration file (:ref:`card10_cfg`).
+
+.. automodule:: config
+   :members:
+
+

Documentation/pycardium/display.rst

+``display`` - Display
+=====================
+
+The display module let's you draw on the card10's display.
+Pixels are addressed from top left to bottom right with a range of x: 0 to 159 and y: 0 to 79.
+
+.. code-block:: text
+
+   0,0
+      +---------------------+
+      |                     |
+      |                     |
+      |                     |
+      |                     |
+      +---------------------+
+                           159,79
+
+Drawing operations are clipped, pixels outside of the screen will be ignored.
+
+.. automodule:: display
+   :members:

Documentation/pycardium/gpio.rst

+.. py:module:: gpio
+
+``gpio`` - GPIO Pins
+==========================
+The :py:mod:`gpio` module allows you to use card10's GPIO pins as input and
+output in your scripts.
+
+**Example**:
+
+.. code-block:: python
+
+   import gpio
+
+   gpio.set_mode(gpio.WRISTBAND_1, gpio.mode.OUTPUT)
+   gpio.write(gpio.WRISTBAND_1, True)
+
+   gpio.set_mode(gpio.WRISTBAND_2, gpio.mode.INPUT | gpio.mode.PULL_UP)
+   state = gpio.read(gpio.WRISTBAND_2)
+   print("State of Wristband pin 2:", state)
+
+.. py:function:: set_mode(pin, mode)
+
+   Configure GPIO pin state.
+
+   :param int pin: ID of the pin to be configured.
+   :param int mode: An integer with the bits for the wanted mode set. Create your
+      integer by ORing :py:data:`gpio.mode.OUTPUT`, :py:data:`gpio.mode.INPUT`,
+      :py:data:`gpio.mode.ADC`, :py:data:`gpio.mode.PULL_UP`,
+      :py:data:`gpio.mode.PULL_DOWN`.
+
+   .. note:: On WRISTBAND_3, there is no ADC functionality available
+
+.. py:function:: get_mode(pin)
+
+   Get GPIO pin state.
+
+   :param int pin: ID of the pin of to get the mode of.
+   :returns: An integer with the configure mode bits set.
+
+.. py:function:: write(pin, value)
+
+   Write a value to a GPIO pin.
+
+   :param int pin: ID of the pin of to get the mode of.
+   :param bool value: New pin value.
+
+.. py:function:: read(pin)
+
+   Read GPIO pin value.
+
+   :param int pin: ID of the pin of to get the mode of.
+   :returns: Current value of the GPIO pin.
+      If the pin is configured as ADC, the value returned
+      will be between 0 and 1000, representing voltages from
+      0V to 3.3V (:py:data:`gpio.ADC` is only available in 1.9+).
+
+.. py:data:: WRISTBAND_1
+
+   Pin ID for Wristband GPIO 1.
+
+.. py:data:: WRISTBAND_2
+
+   Pin ID for Wristband GPIO 2.
+
+.. py:data:: WRISTBAND_3
+
+   Pin ID for Wristband GPIO 3.
+
+.. py:data:: WRISTBAND_4
+
+   Pin ID for Wristband GPIO 4.
+
+
+.. py:module:: gpio.mode
+
+.. py:data:: OUTPUT
+
+   Configures a pin as output.
+
+.. py:data:: INPUT
+
+   Configures a pin as input.
+
+.. py:data:: ADC
+
+   Configure pin as ADC input.
+
+   .. versionadded: 1.9
+
+.. py:data:: PULL_UP
+
+   Enables the internal pull-up resistor of a pin.
+
+.. py:data:: PULL_DOWN
+
+   Enables the internal pull-down resistor of a pin.

Documentation/pycardium/leds.rst

 ``leds`` - LEDs
 ===============
+The ``leds`` module provides functions to interact with card10's RGB LEDs.
+This is the 11 LEDs above the display and 4 LEDs on the underside of the
+top-board, in the four corners.
 
-.. py:function:: leds.set(led, color)
+.. automodule:: leds
+   :members:
 
-   Set one of the card10's RGB LEDs to a certain color.
+``ledfx`` - LED Effects
+=======================
 
-   **Example**:
-
-   .. code-block:: python
-
-      import leds, color
-
-      # Set all of the top LEDs to red
-      for i in range(11):
-         leds.set(i, color.RED)
-
-   :param led:  Which led to set.  0-10 are the leds on the top
-      and 11-14 are the 4 "ambient" leds.
-   :param color:  What color to set the led to.  Should be a
-      :py:class:`color.Color` but any list/tuple with 3 elements
-      will work just as well.
-
-.. py:data:: leds.BOTTOM_RIGHT
-
-   Index of the LED in the bottom right of card10.
-
-.. py:data:: leds.BOTTOM_LEFT
-
-   Index of the LED in the bottom left of card10.
-
-.. py:data:: leds.TOP_RIGHT
-
-   Index of the LED in the top right of card10.
-
-.. py:data:: leds.TOP_LEFT
-
-   Index of the LED in the top left of card10.
+.. automodule:: ledfx
+   :members:

Documentation/pycardium/light-sensor.rst

+.. py:module:: light_sensor
+
+``light_sensor`` - Ambient Brightness
+=====================================
+On the harmonic board, there is an IR-LED which can be used in reverse as a
+crude brightness sensor.  Values returned are in no particular unit but seem to
+be fairly stable.
+
+.. py:function:: start()
+
+   Turn on the ADC and start reading brightness values.  (In past this function must be
+   called before any measurements can be taken.)
+
+.. py:function:: get_reading()
+
+   Get an ambient brightness reading.  The returned value is in no particular
+   unit, though it seems to be fairly stable. The value could be between 0 and 400.  Common values:
+
+   - ~8: Very dark are
+   - ~17: Typical hackerspace brightness
+   - >200: Direct sunlight
+
+   :returns: A brightness reading in no particular unit
+
+.. py:function:: stop()
+
+   Stop the ADC.
+
+.. py:function:: read()
+
+   Direct readout of the light-sensor.
+
+   Use this function for low latency readout.  The time between polls can have
+   an effect on the values measures.  If you do not need low latency, prefer
+   :py:func:`light_sensor.get_reading`.
+
+   .. versionadded:: 1.8

Documentation/pycardium/max30001.rst

+``max30001`` - MAX30001
+=======================
+
+.. automodule:: max30001
+   :members:

Documentation/pycardium/max86150.rst

+``max86150`` - MAX86150
+=======================
+
+.. automodule:: max86150
+   :members:

Documentation/pycardium/os.rst

+.. py:module:: os
+
+``os`` - OS Functions
+=====================
+The ``os`` module allows access to a few core functionalities of Epicardium and
+functions found in CPythons ``os`` module.
+
+CPython-Like
+------------
+
+.. py:function:: listdir(dir)
+
+   List contents of a directory.
+
+   :param str dir: Path to the directory to list.
+   :returns: A list of entities (files or subdirectories) in the directory
+      ``dir``.
+
+.. py:function:: mkdir(path)
+
+   Create a directory named *path*.
+
+   :param str path: Path to the directory to create.  Only the last component
+      of this path will be created.
+
+.. py:function:: rename(src, dst)
+
+   Rename the file or directory *src* to *dst*. If *dst* exists, the operation
+   will fail.
+
+   :param str src: Path to source file to rename.
+   :param str dst: Destination path to rename to.  Must not exist before
+      calling :py:func:`os.rename`.
+
+.. py:function:: unlink(path)
+
+   Unlink (remove) a file.
+
+   :param str path: The file to remove.
+
+.. py:function:: urandom(n)
+
+   Return ``n`` random bytes.
+
+   .. versionadded:: 1.3
+
+   :param int n: Number of random bytes to retrieve.
+   :returns: ``bytes()`` object with ``n`` random bytes.
+
+
+Card10-Specific
+---------------
+
+.. py:function:: exit(ret = None)
+
+   Exit from the current app and return to the menu.
+
+
+   :param int ret: Optional return code, same semantics as Posix (``0`` means
+      success).
+   :return: This function will never return.
+
+.. py:function:: exec(name)
+
+   Try executing a new app, stopping the currently running one.
+
+   ``name`` is the path to either a l0dable (ending in ``.elf``) or a python
+   script (ending in ``.py``).  If the path does not lead to an executable file,
+   ``os.exec()`` will raise an exception.
+
+   :param str name: Path to new app/script/l0dable.
+   :return: This function never returns.  It can, however raise an exception.
+
+.. py:function:: read_battery()
+
+   Read the current battery voltage in V.  Please keep in mind that battery
+   voltage behaves exponentially when interpreting this value.
+
+   .. warning::
+
+      Card10 will hard-shutdown once the voltage drops below 3.4 V
+
+.. py:function:: reset()
+
+   Reboot card10.
+
+   .. warning::
+
+      Please only call this function if absolutely necessary.  In most cases
+      you'll want to just :py:func:`os.exit` instead.
+
+.. py:function:: usbconfig(config_type)
+
+   Change active USB configuration. By default, card10 boots with
+   :py:data:`os.USB_SERIAL` active.
+
+   This will deactivate the currently active USB configuration. This means
+   that, if you activate :py:data:`os.USB_FLASH` while :py:data:`os.USB_SERIAL`
+   was active, the USB serial will be disconnected.
+
+   :param config_type: Selects which config to activate. Possible
+      values are :py:data:`os.USB_SERIAL`, :py:data:`os.USB_FLASH`,
+      or :py:data:`os.USB_NONE`.
+
+   .. versionadded:: 1.11
+
+.. py:data:: USB_NONE
+
+   No USB device active.
+
+.. py:data:: USB_SERIAL
+
+   CDC-ACM serial device active.
+
+.. py:data:: USB_FLASH
+
+   Mass-Storage device active.
+
+.. py:function:: fs_is_attached()
+
+   Check whether the filesystem is currently attached to card10 (or whether a connected
+   USB host is currently holding control over it and possibly writing to it).
+
+   :returns:
+
+      - ``True`` if the filesystem is attached to card10 and an app can read and
+        write files.
+      - ``False`` if the filesystem is not available to card10 because a USB
+        host is currently controlling it.
+
+   .. versionadded: 1.18

Documentation/pycardium/overview.rst

@@ -33,11 +33,56 @@ systems this device will be called ``/dev/ttyACM0`` or ``/dev/ttyACM1``.
 Choose a terminal-emulator of your liking and open the above mentioned device.
 Baud-rate is 115200.  Some options are:
 
-* **screen**: ``screen /dev/ttyACM0 115200``
-* **picocom**: ``picocom -b 115200 /dev/ttyACM0``
+* **screen**: ``sudo screen /dev/ttyACM0 115200``
+* **picocom**: ``sudo picocom -b 115200 /dev/ttyACM0``
 
-After connecting, reboot card10 and you should see the MicroPython REPL pop up.
+After connecting, reboot reset the card10 via the power button (left upper
+corner) and you should see the output of **menu.py** script (it's located in
+*preload/menu.py*). You can press CTRL-C to interrupt the script and jump into
+the MicroPython prompt.
 
-.. todo::
+To switch on the blue fairy dust you must import the led python module::
 
-   Getting Started Guide for people interested in writing Python code.
+   import leds
+
+and power it on::
+
+   leds.set_rocket(0, 31)
+
+.. note::
+
+   If you're using iOS/Mac then you can connect to your serial console using:
+
+   .. code-block:: shell-session
+
+      screen /dev/tty.usbmodem* 115200
+
+   You can now see in your console what buttons you have pressed and your
+   console outputs/logs.  With ``CTRL+C`` you exit the console.
+
+REPL modes
+^^^^^^^^^^
+MicroPython supports a different REPL modes over the serial console. The modes
+can be changed on every new line.
+
+Normal mode
+"""""""""""
+This is the mode you will first see. You can switch to it by pressing CTRL-B.
+If you are in a other mode you can return to this mode by pressing CTRL-B too.
+
+Paste mode
+""""""""""
+You can enter the paste mode by pressing CTRL-E and you can simple copy 'n'
+paste your source code into the console and it will be interpreted and executed
+line by line. Every new line will be reply by the prompt with **===**.
+
+RAW mode
+""""""""
+The RAW mode to be intendend for the usage with tools. By pressing CTRL-A you
+will enter the RAW REPL mode. The type in code will not printed. By pressing
+CTRL-D the whole entered code will be evaluated and executed. The board will
+reply with **OK** and print after that the output (print commands) of the code
+or give you tracebacks if an error occured.
+
+You can use **pycard10** (tools/pycard10.py) to execute python files from your
+PC directly on the card10.

Documentation/pycardium/personal_state.rst

+.. py:module:: personal_state
+
+``personal_state`` - Personal State
+===================================
+The :py:mod:`personal_state` module allows you to set and get the card10 users
+`personal state`_ from your script. The personal state is displayed on the
+top-left LED on the bottom of the harmonics board. While the personal state is
+set the LED can't be controlled by the :py:mod:`leds` module.
+
+.. _personal state: https://card10.badge.events.ccc.de/ps/
+
+**Example**:
+
+.. code-block:: python
+
+   import personal_state
+
+   # Enable the "camp" state only while the app is running.
+   personal_state.set(personal_state.CAMP, False)
+
+   # Enable the "chaos" state and keep it after the app exits.
+   personal_state.set(personal_state.CHAOS, True)
+
+   # Query the currently configured state and if it's persistent.
+   state, persistent = personal_state.get()
+
+   # Clear the currently configured state
+   personal_state.clear()
+
+.. py:function:: set(state, persistent)
+
+   Set the users personal state.
+
+   :param int state: ID of the personal state to set. Must be one of
+      :py:data:`personal_state.NO_CONTACT`, :py:data:`personal_state.CHAOS`,
+      :py:data:`personal_state.COMMUNICATION`, :py:data:`personal_state.CAMP`.
+   :param int persistent: Controls whether the personal state is persistent. A
+      persistent state is not reset when the pycardium application is changed
+      or restarted. In persistent mode the personal state LED is not
+      controllable by the pycardium application.
+
+.. py:function:: clear()
+
+   Clears a previously set personal state.
+
+   If no personal state was set this function does nothing. It does not matter
+   if a set state is marked as persistent or not.
+
+.. py:function:: get()
+
+   Get the users personal state.
+
+   :returns: A tuple containing the currently set state and a boolean
+      indicating if it's persistent or not.
+
+.. py:data:: NO_STATE
+
+   State ID reported when no personal state is set.
+
+.. py:data:: NO_CONTACT
+
+   State ID for the "No Contact" personal state.
+
+.. py:data:: CHAOS
+
+   State ID for the "Chaos" personal state.
+
+.. py:data:: COMMUNICATION
+
+   State ID for the "Communicatoin" personal state.
+
+.. py:data:: CAMP
+
+   State ID for the "Camp" personal state.

Documentation/pycardium/png.rst

+``png`` - PNG Decoder
+=====================
+The ``png`` module provides functions to decode PNG files into raw pixel data
+which can be displayed using the card10's display or its LEDs.
+
+.. automodule:: png
+   :members:

Documentation/pycardium/power.rst

+.. py:module:: power
+
+``power`` - PMIC power module handling
+======================================
+.. versionadded:: 1.4
+
+The :py:mod:`power` module allows you to read the card10's power status
+in your scripts.
+
+**Example**:
+
+.. code-block:: python
+
+   import power
+
+   print(power.read_battery_voltage())
+
+.. py:function:: read_battery_voltage()
+
+   Read the battery voltage in V.  Please keep in mind that battery
+   voltage behaves exponentially when interpreting this value.
+
+   .. warning::
+
+      Card10 will hard-shutdown once the voltage drops below 3.4 V
+
+   .. versionadded:: 1.4
+
+.. py:function:: read_battery_current()
+
+   Read the battery-side current flow in A.
+
+   .. versionadded:: 1.4
+
+.. py:function:: read_chargein_voltage()
+
+   Read the charge voltage in V.
+
+   .. versionadded:: 1.4
+
+.. py:function:: read_chargein_current()
+
+   Read the charge current in A.
+
+   .. versionadded:: 1.4
+
+.. py:function:: read_system_voltage()
+
+   Read the system-side voltate in V.
+
+   .. versionadded:: 1.4
+
+.. py:function:: read_thermistor_voltage()
+
+   Read the thermistor voltage in V.
+
+   There is a resistor network from GND over a thermistor
+   (10K at room temperature) over 10K to the Thermistor Bias voltage.
+   This reads the voltage between thermistor and resistor.
+
+   .. versionadded:: 1.4

Documentation/pycardium/pride.rst

+``pride`` - Pride flags
+=======================
+The ``pride`` module provides an easy interface to print pride flags to the top LEDs and the display.
+
+.. automodule:: pride
+   :members:
+

Documentation/pycardium/simple_menu.rst

+``simple_menu`` - Draw a Menu
+=============================
+.. versionadded:: 1.4
+
+To allow quickly hacking some scripts, Pycardium has a small library for
+displaying menus.  You can use it like this:
+
+.. code-block:: python
+
+   import color
+   import simple_menu
+
+
+   class MyMenu(simple_menu.Menu):
+       color_1 = color.CAMPGREEN
+       color_2 = color.CAMPGREEN_DARK
+
+       def on_select(self, name, index):
+           print("{!r} was selected!".format(name))
+
+
+   if __name__ == "__main__":
+       MyMenu(["foo", "bar", "baz"]).run()
+
+.. autoclass:: simple_menu.Menu
+   :members:
+
+.. autodata:: simple_menu.TIMEOUT
+
+.. autofunction:: simple_menu.button_events

Documentation/pycardium/stdlib.rst

+MicroPython Standard Library
+============================
+Pycardium contains some modules from the MicroPython standard library.
+
+Some modules below use a standard Python name, but prefixed with “u”,
+e.g. ujson instead of json. This is to signify that such a module is a
+micro-library, i.e. implements only a subset of CPython module
+functionality. Please refer to the official `MicroPython docs`_ for an
+explanation why.
+
+All u-name modules can also be imported using their non-u-name. E.g.
+``import utime`` and import ``import time`` will both work.
+
+.. _MicroPython docs: http://docs.micropython.org/en/latest/library/index.html#python-standard-libraries-and-micro-libraries
+
+.. py:module:: framebuf
+
+``framebuf``
+------------
+Refer to the official `MicroPython docs for framebuf`_.
+
+.. _MicroPython docs for framebuf: https://docs.micropython.org/en/latest/library/framebuf.html
+
+.. py:module:: ubinascii
+
+``ubinascii``
+-------------
+Refer to the official `MicroPython docs for ubinascii`_.
+
+.. _MicroPython docs for ubinascii: http://docs.micropython.org/en/latest/library/ubinascii.html
+
+.. py:module:: ucollections
+
+``ucollections``
+----------------
+
+.. py:function:: namedtuple(...)
+
+   See the official `MicroPython docs for namedtuple`_ for details.
+
+   .. _MicroPython docs for namedtuple: http://docs.micropython.org/en/latest/library/ucollections.html#ucollections.namedtuple
+
+.. py:module:: uerrno
+
+``uerrno``
+----------
+Refer to the offical `MicroPython docs for uerrno`_.
+
+.. _MicroPython docs for uerrno: http://docs.micropython.org/en/latest/library/uerrno.html
+
+.. py:module:: uheapq
+
+``uheapq``
+----------
+Refer to the offical `MicroPython docs for uheapq`_.
+
+.. _MicroPython docs for uheapq: http://docs.micropython.org/en/latest/library/uheapq.html
+
+.. py:module:: uio
+
+``uio``
+-------
+Refer to the offical `MicroPython docs for uio`_.
+
+.. _MicroPython docs for uio: http://docs.micropython.org/en/latest/library/uio.html
+
+.. py:module:: ujson
+
+``ujson``
+---------
+Refer to the offical `MicroPython docs for ujson`_.
+
+.. _MicroPython docs for ujson: http://docs.micropython.org/en/latest/library/ujson.html
+
+.. py:module:: urandom
+
+``urandom``
+-----------
+Pseudo-random number generator.
+
+.. py:function:: choice(seq)
+
+   Return a random element from the non-empty sequence ``seq``.
+
+.. py:function:: getrandbits(k)
+
+   Returns a Python integer with ``k`` random bits.
+
+.. py:function:: randint(a, b)
+
+   Return a random integer ``N`` such that ``a <= N <= b``. Alias for
+   :py:func:`randrange(a, b+1) <urandom.randrange>`.
+
+.. py:function:: random()
+
+   Return the next random floating point number in the range [0.0, 1.0).
+
+.. py:function:: randrange(start, stop, [step])
+
+.. py:function:: randrange(stop)
+   :noindex:
+
+   Return a randomly selected element from ``range(start, stop, step)``. This
+   is equivalent to ``urandom.choice(range(start, stop, step))``, but doesn’t
+   actually build a range object.
+
+   The positional argument pattern matches that of ``range()``. Keyword
+   arguments should not be used because the function may use them in unexpected
+   ways.
+
+.. py:function:: seed(n)
+
+   Seed the pseudo-random number generator from ``n``.
+
+   .. note::
+
+      CPython does not provide a :py:func:`seed` function.  This is a
+      difference in the MicroPython implementation.
+
+.. py:function:: uniform(a, b)
+
+   Return a random floating point number ``N`` such that ``a <= N <= b`` for
+   ``a <= b`` and ``b <= N <= a`` for ``b < a``.
+
+   The end-point value ``b`` may or may not be included in the range depending
+   on floating-point rounding in the equation ``a + (b-a) * random()``.
+
+.. py:module:: ure
+
+``ure``
+-------
+Minimal regular expression library.  Refer to the offical `MicroPython docs for ure`_.
+
+.. _MicroPython docs for ure: http://docs.micropython.org/en/latest/library/ure.html
+
+.. py:module:: ustruct
+
+``ustruct``
+-----------
+Refer to the offical `MicroPython docs for ustruct`_.
+
+.. _MicroPython docs for ustruct: http://docs.micropython.org/en/latest/library/ustruct.html
+
+``utime``
+---------
+``utime`` contains non-standard functions as well.  Please refer to our
+dedicated :py:mod:`utime` docs.
+
+
+Python Standard Library
+=======================
+Additionally to the MicroPython module, Pycardium contains a subset of the
+CPython standard library, as implemented by `micropython-lib`_.  The following
+modules are included:
+
+.. _micropython-lib: https://github.com/micropython/micropython-lib
+
+.. py:module:: collections
+
+``collections``
+---------------
+Collections module.
+
+.. py:module:: contextlib
+
+``contextlib``
+--------------
+Contextlib module.
+
+.. py:module:: functools
+
+``functools``
+-------------
+Functools module.
+
+.. py:module:: itertools
+
+``itertools``
+-------------
+Itertools module.
+
+.. warning::
+
+   :py:func:`itertools.tee` is not implemented correctly.
+
+.. py:module:: string
+
+``string``
+----------
+String module.
+
+.. py:module:: struct
+
+``struct``
+----------
+Struct module.
+
+.. py:module:: uuid
+
+``uuid``
+--------
+
+.. py:class:: UUID(hex=None, bytes=None, int=None, version=None)
+
+   Create a new UUID object.
+
+   Exactly one of ``hex``, ``bytes``, or ``int`` must be given.  The
+   ``version`` argument is optional; if given, the resulting UUID will have its
+   variant and version set according to RFC 4122, overriding the given ``hex``,
+   ``bytes``, or ``int``.
+
+   **Examples**:
+
+   .. code-block:: python
+
+      UUID('{12345678-1234-5678-1234-567812345678}')
+      UUID('12345678123456781234567812345678')
+      UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
+      UUID(bytes='\x12\x34\x56\x78' * 4)
+      UUID(int=0x12345678123456781234567812345678)
+
+   .. versionadded:: 1.10
+
+   .. py:attribute:: bytes
+
+      UUID as ``bytes()`` object
+
+   .. py:attribute:: node
+
+      Node of this UUID
+
+   .. py:attribute:: hex
+
+      Hex-String representation of this UUID
+
+   .. py:attribute:: version
+
+      UUID version accordiung to RFC 4122
+
+.. py:function:: uuid4()
+
+   Generate a new UUID version 4 (random UUID).
+
+   .. versionadded:: 1.10

Documentation/pycardium/utime.rst

+.. py:module:: utime
+
+``utime`` - Time
+================
+The ``utime`` module loosely follows CPython's |time|_ module, but is heavily
+stripped down.  Instead, it has a few time related functions which are not in
+CPython but wouldn't fit anywhere else in our implementation.  Most
+prominently,  this is the :py:func:`utime.alarm` function for setting an RTC
+alarm.
+
+Like all other u-name modules, ``utime`` can also imported using the standard
+``import time`` statement.
+
+.. |time| replace:: ``time``
+.. _time: https://docs.python.org/3/library/time.html
+
+.. py:function:: sleep(secs)
+
+   Sleep for ``secs`` seconds.  Can take a floating-point value.
+
+.. py:function:: sleep_ms(msecs)
+
+   Sleep for ``msecs`` milliseconds.  Only takes integer values.
+
+.. py:function:: sleep_us(usecs)
+
+   Sleep for ``usecs`` microseconds.  Only takes integer values.
+
+.. py:function:: time()
+
+   Return the current timestamp in seconds since 2000-01-01 00:00 in
+   the local timezone.
+
+.. py:function:: time_ms()
+
+   Return the current timestamp in milliseconds since 2000-01-01 00:00 in
+   the local timezone.
+
+.. py:function:: monotonic()
+
+   Return a monotonically increasing timestamp.
+
+   .. versionadded:: 1.11
+
+.. py:function:: monotonic_ms()
+
+   Return a monotonically increasing timestamp in milliseconds.
+
+   .. versionadded:: 1.11
+
+.. py:function:: ticks_ms()
+
+   Return processor ticks (converted to milliseconds) since Pycardium startup.
+
+   This function should be the preferred method for timing and profiling
+   because it does not need an API call and thus is very fast.
+
+   .. versionadded:: 1.13
+
+.. py:function:: ticks_us()
+
+   Return processor ticks (converted to microseconds) since Pycardium startup.
+
+   This function should be the preferred method for timing and profiling
+   because it does not need an API call and thus is very fast.
+
+   .. versionadded:: 1.13
+
+.. py:function:: unix_time()
+
+   Return the current unix time as seconds since the epoch.
+
+   .. versionadded:: 1.12
+
+.. py:function:: unix_time_ms()
+
+   Return the current unix time as milliseconds since the epoch.
+
+   .. versionadded:: 1.12
+
+.. py:function:: set_time(secs)
+
+   Sets the time to ``secs`` seconds since 2000-01-01 00:00 in the local
+   timezone.
+
+   .. versionchanged:: 1.4
+      :py:func:`utime.set_time` previously applied a wrong timezone offset,
+      thus leading to wrong results.
+
+.. py:function:: set_time_ms(msecs)
+
+   Set the time to ``msecs`` seconds since 2000-01-01 00:00 in the local
+   timezone.
+
+   .. versionadded:: 1.12
+
+.. py:function:: set_unix_time(secs)
+
+   Sets the time to ``secs`` seconds since 1970-01-01 00:00 UTC.
+   This corresponds to a regular Unix timestamp which can be obtained
+   by running ``date +%s`` in a command line or ``int(time.time())``
+   in Python.
+
+.. py:function:: set_unix_time_ms(msecs)
+
+   Set the time to ``msecs`` milliseconds since the unix epoch.
+
+   .. versionadded:: 1.12
+
+.. py:function:: localtime([secs])
+
+   Return the current time as a timestruct tuple.  If ``secs`` is given, return
+   its timestruct tuple instead.  Timestruct tuple looks like:
+
+   .. code-block:: python
+
+      (year, month, mday, hour, min, sec, wday, yday)
+      #   0      1     2     3    4    5     6     7
+
+.. py:function:: mktime(t)
+
+   Convert timestruct tuple into a seconds time stamp.  See
+   :py:func:`utime.localtime` for details about timestruct tuples.
+
+   :returns: Seconds since 2000-01-01
+
+.. py:function:: alarm(secs, [callback])
+
+   Register the next RTC alarm for the timestamp ``secs``.  ``secs`` is seconds
+   since 2000-01-01.
+
+   If an optional ``callback`` is given, it will be registered for the RTC
+   alarm interrupt.  This will overwrite any previous interrupt handler.  If
+   ``callback`` is given, :c:func:`utime.alarm` will also enable the RTC alarm
+   interrupt.
+
+   **Example**:
+
+   .. code-block:: python
+
+      import time
+
+      def minute_timer(x):
+         current = time.time()
+         print("Current: " + str(current))
+         alarm = (current // 60 + 1) * 60
+         time.alarm(alarm, minute_timer)
+
+      minute_timer(None)
+
+   Alternatively, you can register a callback using the interrupt module and
+   then call :py:func:`utime.alarm` without a ``callback`` parameter:
+
+   .. code-block:: python
+
+      import interrupt, time
+
+      def 5_second_timer(x):
+         current = time.time()
+         print("Current: " + str(current))
+         alarm = (current // 10) * 10 + 5
+         time.alarm(alarm)
+
+      # This time, we need to register and enable the callback manually
+      interrupt.set_callback(interrupt.RTC_ALARM, 5_second_timer)
+      interrupt.enable_callback(interrupt.RTC_ALARM)
+
+      5_second_timer(None)

Documentation/pycardium/vibra.rst

+.. py:module:: vibra
+
+``vibra`` - Vibration Motor
+===========================
+
+.. py:function:: vibra.vibrate(millis)
+
+   Turn on the vibration motor for a certain duration.
+
+   **Example**:
+
+   .. code-block:: python
+
+      import vibra
+
+      # Turn on vibration motor for 60 ms
+      vibra.vibrate(60)
+
+   :param int millis:  Duration for the vibration motor to be on.
+
+
+.. py:function:: vibra.set(state)
+
+   Permanently set the state of the vibration motor to either *on* or *off*.
+
+   .. warning::
+
+      If your code for some reason crashes between turning the motor on and
+      back off again, the motor will continue running.  Consider using
+      :py:func:`vibra.vibrate` instead.
+
+   :param bool state: ``True`` to turn on, ``False`` to turn the motor off.

Documentation/pycardium/ws2812.rst

+.. py:module:: ws2812
+
+``ws2812`` - Neopixel LEDs
+==========================
+The ``ws2812`` module controls LEDs of the WS2812 type. Just as the ``leds`` module, it exposes a function :py:func:`ws2812.set_all`, which works a similar fashion.
+
+.. versionadded:: 1.10
+
+.. py:function:: set_all(pin, colors)
+
+   Set multiple of the LEDs to RGB values.
+
+   Filling starts at the LED connected to the specified gpio pin.
+
+   :param int pin: ID of the pin to use for sending the data.
+   :param colors: List of RGB triplets.
+
+   **Example**
+
+   .. code-block:: python
+
+      import color, time, ws2812, gpio
+
+      gpio.set_mode(gpio.WRISTBAND_2, gpio.mode.OUTPUT)
+
+      i = 0
+      while True:
+          col1 = color.from_hsv(i % 360, 1.0, 0.1)
+          col2 = color.from_hsv((i + 20) % 360, 1.0, 0.1)
+          col3 = color.from_hsv((i + 40) % 360, 1.0, 0.1)
+          ws2812.set_all(gpio.WRISTBAND_2, [col1, col2, col3])
+          i += 1
+          time.sleep_ms(10)
+
+   .. versionadded:: 1.10