Documentation/hawkmoth/__init__.py

@@ -52,7 +52,10 @@ class CAutoDocDirective(Directive):
         env = self.state.document.settings.env
 
         for (severity, filename, lineno, msg) in errors:
+            if filename:
                 toprint = '{}:{}: {}'.format(filename, lineno, msg)
+            else:
+                toprint = '{}'.format(msg)
 
             if severity.value <= env.app.verbosity:
                 self.logger.log(self._log_lvl[severity], toprint,
@@ -109,7 +112,7 @@ class CAutoDocDirective(Directive):
         return node.children
 
 def setup(app):
-    app.require_sphinx('1.8')
+    app.require_sphinx('3.0')
     app.add_config_value('cautodoc_root', app.confdir, 'env')
     app.add_config_value('cautodoc_compat', None, 'env')
     app.add_config_value('cautodoc_clang', None, 'env')

Documentation/hawkmoth/__main__.py

@@ -39,7 +39,10 @@ def main():
         print(doc)
 
     for (severity, filename, lineno, msg) in errors:
+        if filename:
             print('{}: {}:{}: {}'.format(severity.name,
                                          filename, lineno, msg), file=sys.stderr)
+        else:
+            print('{}: {}'.format(severity.name, msg), file=sys.stderr)
 
 main()

Documentation/hawkmoth/parser.py

 # Copyright (c) 2016-2017 Jani Nikula <jani@nikula.org>
-# Copyright (c) 2018-2019 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>
+# Copyright (c) 2018-2020 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>
 # Licensed under the terms of BSD 2-Clause, see LICENSE for details.
 """
 Documentation comment extractor
@@ -34,7 +34,7 @@ Otherwise, documentation comments are passed through verbatim.
 """
 
 import enum
-import itertools
+import re
 import sys
 
 from clang.cindex import CursorKind, TypeKind
@@ -75,18 +75,22 @@ def comment_extract(tu):
             current_comment = token
             continue
 
+        # Store off the token's cursor for a slight performance improvement
+        # instead of accessing the `cursor` property multiple times.
+        token_cursor = token.cursor
+
         # cursors that are 1) never documented themselves, and 2) allowed
         # between comment and the actual cursor being documented
-        if (token.cursor.kind == CursorKind.INVALID_FILE or
-            token.cursor.kind == CursorKind.TYPE_REF or
-            token.cursor.kind == CursorKind.PREPROCESSING_DIRECTIVE or
-            token.cursor.kind == CursorKind.MACRO_INSTANTIATION):
+        if (token_cursor.kind == CursorKind.INVALID_FILE or
+            token_cursor.kind == CursorKind.TYPE_REF or
+            token_cursor.kind == CursorKind.PREPROCESSING_DIRECTIVE or
+            token_cursor.kind == CursorKind.MACRO_INSTANTIATION):
             continue
 
-        if cursor is not None and token.cursor == cursor:
+        if cursor is not None and token_cursor == cursor:
             continue
 
-        cursor = token.cursor
+        cursor = token_cursor
 
         # Note: current_comment may be None
         if current_comment != None and docstr.is_doc(current_comment.spelling):
@@ -125,16 +129,18 @@ def _get_macro_args(cursor):
     if cursor.kind != CursorKind.MACRO_DEFINITION:
         return None
 
+    tokens = cursor.get_tokens()
+
     # Use the first two tokens to make sure this starts with 'IDENTIFIER('
-    x = [token for token in itertools.islice(cursor.get_tokens(), 2)]
-    if (len(x) != 2 or x[0].spelling != cursor.spelling or
-        x[1].spelling != '(' or x[0].extent.end != x[1].extent.start):
+    one = next(tokens)
+    two = next(tokens, None)
+    if two is None or one.extent.end != two.extent.start or two.spelling != '(':
         return None
 
     # Naïve parsing of macro arguments
     # FIXME: This doesn't handle GCC named vararg extension FOO(vararg...)
     args = []
-    for token in itertools.islice(cursor.get_tokens(), 2, None):
+    for token in tokens:
         if token.spelling == ')':
             return args
         elif token.spelling == ',':
@@ -161,8 +167,26 @@ def _recursive_parse(comments, cursor, nest, compat):
         return _result(comment, cursor=cursor, fmt=fmt,
                        nest=nest, name=name, args=args, compat=compat)
 
-    elif cursor.kind == CursorKind.VAR_DECL:
+    elif cursor.kind in [CursorKind.VAR_DECL, CursorKind.FIELD_DECL]:
+        if cursor.kind == CursorKind.VAR_DECL:
             fmt = docstr.Type.VAR
+        else:
+            fmt = docstr.Type.MEMBER
+
+        # If this is an array, the dimensions should be applied to the name, not
+        # the type.
+        dims = ttype.rsplit(' ', 1)[-1]
+        if dims.startswith('[') and dims.endswith(']'):
+            ttype = ttype.rsplit(' ', 1)[0]
+            name = name + dims
+
+        # If this is a function pointer, or an array of function pointers, the
+        # name should be within the parenthesis as in (*name) or (*name[N]).
+        fptr_type = re.sub(r'\((\*+)(\[[^]]*\])?\)', r'(\1{}\2)'.format(name),
+                           ttype, count=1)
+        if fptr_type != ttype:
+            name = fptr_type
+            ttype = ''
 
         return _result(comment, cursor=cursor, fmt=fmt,
                        nest=nest, name=name, ttype=ttype, compat=compat)
@@ -188,9 +212,15 @@ def _recursive_parse(comments, cursor, nest, compat):
 
         # FIXME: Handle anonymous enumerators.
 
-        fmt = docstr.Type.TYPE
+        fmts = {CursorKind.STRUCT_DECL: docstr.Type.STRUCT,
+                CursorKind.UNION_DECL: docstr.Type.UNION,
+                CursorKind.ENUM_DECL: docstr.Type.ENUM}
+
+        fmt = fmts[cursor.kind]
+
+        # name may be empty for typedefs
         result = _result(comment, cursor=cursor, fmt=fmt,
-                         nest=nest, name=ttype, compat=compat)
+                         nest=nest, name=name if name else ttype, compat=compat)
 
         nest += 1
         for c in cursor.get_children():
@@ -205,12 +235,6 @@ def _recursive_parse(comments, cursor, nest, compat):
         return _result(comment, cursor=cursor, fmt=fmt,
                        nest=nest, name=name, compat=compat)
 
-    elif cursor.kind == CursorKind.FIELD_DECL:
-        fmt = docstr.Type.MEMBER
-
-        return _result(comment, cursor=cursor, fmt=fmt,
-                       nest=nest, name=name, ttype=ttype, compat=compat)
-
     elif cursor.kind == CursorKind.FUNCTION_DECL:
         # FIXME: check args against comment
         # FIXME: children may contain extra stuff if the return type is a
@@ -261,7 +285,8 @@ def clang_diagnostics(errors, diagnostics):
            4: ErrorLevel.ERROR}
 
     for diag in diagnostics:
-        errors.extend([(sev[diag.severity], diag.location.file.name,
+        filename = diag.location.file.name if diag.location.file else None
+        errors.extend([(sev[diag.severity], filename,
                         diag.location.line, diag.spelling)])
 
 # return a list of (comment, metadata) tuples

Documentation/hawkmoth/util/docstr.py

-# Copyright (c) 2016-2017 Jani Nikula <jani@nikula.org>
-# Copyright (c) 2018-2019 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>
+# Copyright (c) 2016-2020 Jani Nikula <jani@nikula.org>
+# Copyright (c) 2018-2020 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>
 # Licensed under the terms of BSD 2-Clause, see LICENSE for details.
 """
 Documentation strings manipulation library
@@ -17,6 +17,9 @@ class Type(Enum):
     TEXT = auto()
     VAR = auto()
     TYPE = auto()
+    STRUCT = auto()
+    UNION = auto()
+    ENUM = auto()
     ENUM_VAL = auto()
     MEMBER = auto()
     MACRO = auto()
@@ -31,10 +34,13 @@ _doc_fmt = {
     Type.TEXT:       (0, '\n{text}\n'),
     Type.VAR:        (1, '\n.. c:var:: {ttype} {name}\n\n{text}\n'),
     Type.TYPE:       (1, '\n.. c:type:: {name}\n\n{text}\n'),
-    Type.ENUM_VAL:   (1, '\n.. c:macro:: {name}\n\n{text}\n'),
+    Type.STRUCT:     (1, '\n.. c:struct:: {name}\n\n{text}\n'),
+    Type.UNION:      (1, '\n.. c:union:: {name}\n\n{text}\n'),
+    Type.ENUM:       (1, '\n.. c:enum:: {name}\n\n{text}\n'),
+    Type.ENUM_VAL:   (1, '\n.. c:enumerator:: {name}\n\n{text}\n'),
     Type.MEMBER:     (1, '\n.. c:member:: {ttype} {name}\n\n{text}\n'),
     Type.MACRO:      (1, '\n.. c:macro:: {name}\n\n{text}\n'),
-    Type.MACRO_FUNC: (1, '\n.. c:function:: {name}({args})\n\n{text}\n'),
+    Type.MACRO_FUNC: (1, '\n.. c:macro:: {name}({args})\n\n{text}\n'),
     Type.FUNC:       (1, '\n.. c:function:: {ttype} {name}({args})\n\n{text}\n')
 }
 

Documentation/hawkmoth/util/readthedocs.py

+# Copyright (c) 2021, Jani Nikula <jani@nikula.org>
+# Licensed under the terms of BSD 2-Clause, see LICENSE for details.
+"""
+Read the Docs Helpers
+=====================
+
+Helpers for setting up and using Hawkmoth on Read the Docs.
+"""
+
+import os
+import subprocess
+
+def clang_setup(force=False):
+    """Try to find and configure libclang location on RTD."""
+    if 'READTHEDOCS' in os.environ or force:
+        try:
+            result = subprocess.run(['llvm-config', '--libdir'],
+                                    check=True, capture_output=True, encoding='utf-8')
+            libdir = result.stdout.strip()
+
+            # For some reason there is no plain libclang.so symlink on RTD.
+            from clang.cindex import Config
+            Config.set_library_file(os.path.join(libdir, 'libclang.so.1'))
+        except Exception as e:
+            print(e)

Documentation/how-to-build.rst

@@ -71,14 +71,42 @@ Dependencies
         brew install ninja
         pip3 install --user meson  # see https://mesonbuild.com/Getting-meson.html - you will have to add ~/.local/bin to your PATH.
 
-* **python3-crc16**: Install with ``pip3 install --user crc16``.
-* **python3-pillow**: Python Image Library ``pip3 install --user pillow``.
+* One of two CRC packages is required. Pick one:
+
+  - Ubuntu / Debian / macOS
+
+    .. code-block:: shell-session
+
+        pip3 install --user crc16
+
+or
+
+    .. code-block:: shell-session
+
+        apt install python3-crcmod
+
+or
+
+    .. code-block:: shell-session
+
+        pip3 install --user crcmod
 
   - Arch
 
     .. code-block:: shell-session
 
-       pacman -S python-crc16 python-pillow
+       pacman -S python-crc16
+
+* **python3-pillow**: Python Image Library
+       .. code-block:: shell-session
+
+            pip3 install --user pillow
+
+  - Arch
+
+    .. code-block:: shell-session
+
+       pacman -S python-pillow
 
 .. _ARM's GNU toolchain: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads
 
@@ -161,3 +189,25 @@ Otherwise, rerunning ``./bootstrap.sh`` will also clean the build-directory.
    (it's supposed to create a large file with 0xff in it) - this requires the
    LC_ALL environment variable to be not set, or set to "C"
    (but not UTF8 or similar).
+
+Docker
+======
+Alternatively, clone the ``master`` branch of the firmware repository and enter it:
+
+.. code-block:: shell-session
+
+   $ git clone https://git.card10.badge.events.ccc.de/card10/firmware.git
+   $ cd firmware
+
+Afterwards, build a docker-container which will build the firmware via:
+
+.. code-block:: shell-session
+
+   $ docker build -f docker/Dockerfile_fwbuild -t card10-firmware-builder .
+
+Now, you can start the container with the firmware directory mounted, which will build the
+firmware into the firmware/build directory:
+
+.. code-block:: shell-session
+
+   $ docker run -v $(pwd):/firmware card10-firmware-builder

Documentation/index.rst

@@ -23,16 +23,20 @@ Last but not least, if you want to start hacking the lower-level firmware, the
    pycardium/overview
    pycardium/stdlib
    pycardium/bhi160
+   pycardium/ble_hid
    pycardium/bme680
    pycardium/max30001
+   pycardium/max86150
    pycardium/buttons
    pycardium/color
+   pycardium/config
    pycardium/display
    pycardium/gpio
    pycardium/leds
    pycardium/light-sensor
    pycardium/os
    pycardium/personal_state
+   pycardium/png
    pycardium/power
    pycardium/pride
    pycardium/simple_menu
@@ -52,6 +56,7 @@ Last but not least, if you want to start hacking the lower-level firmware, the
    debugger
    pycardium-guide
    memorymap
+   epicardium/mutex
    epicardium/sensor-streams
 
 .. toctree::
@@ -61,13 +66,18 @@ Last but not least, if you want to start hacking the lower-level firmware, the
    epicardium/overview
    epicardium/api
    epicardium-guide
+   epicardium/internal
 
 .. toctree::
    :maxdepth: 1
    :caption: Bluetooth
 
+   bluetooth/overview
+   bluetooth/ess
    bluetooth/file-transfer
    bluetooth/card10
+   bluetooth/ecg
+   bluetooth/nimble
 
 Indices and tables
 ==================

Documentation/overview.rst

@@ -14,31 +14,32 @@ Epicardium
 Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_.  There are a
 number of tasks that will have been keeping card10 running.  These are:
 
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 | Name               | ID Global                     | Priority | Description                               |
-+===================+===============================+==========+===========================================+
++====================+===============================+==========+===========================================+
 | `vPmicTask`_       | ``pmic_task_id`` (static)     | +4       | Power Management (and Reset Button)       |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 | `vLifecycleTask`_  | ``lifecycle_task`` (static)   | +3       | Control of the payload running on core 1. |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 | `vBleTask`_        | ``ble_task_id`` (static)      | +3       | Bluetooth Low Energy Stack                |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 | `vSerialTask`_     | ``serial_task_id``            | +3       | Serial Output via UART/CDC-ACM/BLE        |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 | `vApiDispatcher`_  | ``dispatcher_task_id``        | +2       | Epicardium API dispatcher                 |
-+-------------------+-------------------------------+----------+-------------------------------------------+
-| `vLedTask`_       | -/-                           | +1       | LED Animations                            |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
+| `vInterruptsTask`_ | ``interrupts_task`` (static)  | +2       | Interrupt dispatcher worker               |
++--------------------+-------------------------------+----------+-------------------------------------------+
 | `vMAX30001Task`_   | ``max30001_task_id`` (static) | +1       | `MAX30001`_ ECG driver                    |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 | `vBhi160Task`_     | ``bhi160_task_id`` (static)   | +1       | `BHI160`_ sensor fusion driver            |
-+-------------------+-------------------------------+----------+-------------------------------------------+
++--------------------+-------------------------------+----------+-------------------------------------------+
 
 .. _vPmicTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/pmic.c#L281
 .. _vLifecycleTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/lifecycle.c#L361
 .. _vBleTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/ble/ble.c#L237
 .. _vSerialTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/serial.c#L289
 .. _vApiDispatcher: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/dispatcher.c#L25
+.. _vInterruptsTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/interrupts.c#L119
 .. _vLedTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/personal_state.c#L58
 .. _vMAX30001Task: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/max30001.c#L378
 .. _vBhi160Task: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/bhi.c#L419
@@ -72,11 +73,13 @@ interface with the :ref:`epicardium_api`.
 
 Note: this feature is disabled by default and has to be enabled in :ref:`card10_cfg`. A :ref:`card10_cfg` file dropped into the :ref:`usb_file_transfer` of the badge containing ``execute_elf = true`` is enough.
 
-l0dables are currently built within the source tree of the main repository. See ``l0dables/blinky`` for an example of a hello-world-like program. Within those programs, you can access the :ref:`epicardium_api` to control the hardware and behaviour of the badge.
+l0dables are currently built within the source tree of the main repository. See |l0dables_blinky|_ for an example of a hello-world-like program. Within those programs, you can access the :ref:`epicardium_api` to control the hardware and behaviour of the badge.
 
 Once you have a built ELF file, you can drop it into the FAT filesystem of the flash (eg. via :ref:`usb_file_transfer`) and it will be available from the menu program of the badge.
 
 .. _Rustcardium: https://git.card10.badge.events.ccc.de/astro/rust-card10
+.. |l0dables_blinky| replace:: ``l0dables/blinky``
+.. _l0dables_blinky: https://git.card10.badge.events.ccc.de/card10/firmware/-/tree/master/l0dables
 
 Program Flow Diagram
 --------------------

Documentation/pycardium/bhi160.rst

@@ -12,42 +12,56 @@ The coordinate system of the BHI160 sensor data looks like this:
 
 .. image:: ../static/bhi160-coordinates.png
 
-All angles and angular velocities (like gyroscope, orientation) rotate counter
-clockwise around their respective axis.
+* The **accelerometer** axes are just the ones shown in the picture.
+* The **gyroscope**'s angular velocities rotate counter clockwise around
+  their respective axis.
+* The **orientation** sensor uses the following mapping:
+
+  +---------------------+----------------------+-------------------+
+  | X                   | Y                    | Z                 |
+  +=====================+======================+===================+
+  | Azimuth (0° - 360°) | Pitch (-180° - 180°) | Roll (-90° - 90°) |
+  +---------------------+----------------------+-------------------+
 
 **Example**:
 
 .. code-block:: python
 
    import bhi160
-   import utime
+   import time
 
    bhi = bhi160.BHI160Orientation()
 
     while True:
         samples = bhi.read()
         if len(samples) == 0:
-            utime.sleep(0.25)
+            time.sleep(0.25)
             continue
         # print the latest sample
         print(samples[-1])
-        utime.sleep(0.25)
-
+        time.sleep(0.25)
 
-.. autoclass:: bhi160.BHI160
 
+Orientation
+-----------
 .. autoclass:: bhi160.BHI160Orientation
    :members:
    :inherited-members:
 
+Accelerometer
+-------------
 .. autoclass:: bhi160.BHI160Accelerometer
   :members:
   :inherited-members:
 
+Gyroscope
+---------
 .. autoclass:: bhi160.BHI160Gyroscope
   :members:
   :inherited-members:
 
+Magnetometer
+------------
 .. autoclass:: bhi160.BHI160Magnetometer
   :members:
   :inherited-members:

Documentation/pycardium/ble_hid.rst

+``ble_hid`` - BLE HID
+=====================
+The ``ble_hid`` module provides access to the BLE Human Interface Device functionality.
+
+.. note::
+    Make sure to enable the BLE HID functionality in :ref:`card10_cfg` and reboot your card10
+    if you want to use BLE HID.
+
+    Also make sure that the ``adafruit_hid`` folder from the card10 release archive is placed
+    on the file system of your card10.
+
+
+.. warning::
+    At least Ubuntu Linux will keep auto connecting to BLE HID devices once they are
+    paired to the host computer. If you want to connect your card10 to a phone again,
+    you might have to temporarily turn off Bluetooth on your computer.
+
+An example application can be found in the preload directory (named ``HID Demo``). It provides
+examples how to use the card10 as keyboard, mouse or volume control.
+
+Please refer to the Adafruit CircuitPython HID library for examples how to use the HID service.
+The card10 implements the same HID descriptors as the Adafruit CircuitPython BLE library and
+should be compatible with all uses of the Adafruit CircuitPython HID library.
+
+**Example emulating a keyboard**:
+
+Adapted from https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/master/CPB_Keybutton_BLE/cpb_keybutton_ble.py
+
+A more complete version of this example can be found in the HID Demo app on your card10.
+
+.. code-block:: python
+
+    import ble_hid
+    from adafruit_hid.keyboard import Keyboard
+    from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
+    from adafruit_hid.keycode import Keycode
+
+    k = Keyboard(ble_hid.devices)
+    kl = KeyboardLayoutUS(k)
+
+    k.send(Keycode.BACKSPACE)
+
+    # use keyboard_layout for words
+    kl.write("Demo with a long text to show how fast a card10 can type!")
+
+    # add shift modifier
+    k.send(Keycode.SHIFT, Keycode.F19)
+
+
+**Example emulating a mouse**:
+
+.. code-block:: python
+
+    import ble_hid
+    import bhi160
+    import buttons
+    from adafruit_hid.mouse import Mouse
+
+    m = Mouse(ble_hid.devices)
+
+    def send_report(samples):
+        if len(samples) > 0:
+            x = -int(samples[0].z)
+            y = -int(samples[0].y)
+            m.move(x, y)
+
+    sensor = bhi160.BHI160Orientation(sample_rate=10, callback=send_report)
+
+    b_old = buttons.read()
+    while True:
+        b_new = buttons.read()
+        if not b_old == b_new:
+            print(b_new)
+            b_old = b_new
+            if b_new == buttons.TOP_RIGHT:
+                m.click(Mouse.MIDDLE_BUTTON)
+            elif b_new == buttons.BOTTOM_RIGHT:
+                m.click(Mouse.RIGHT_BUTTON)
+            elif b_new == buttons.BOTTOM_LEFT:
+                m.click(Mouse.LEFT_BUTTON)
+
+.. note::
+    Make sure to catch ``OSError`` exceptions in real applications. The exception will be thrown if
+    there is connection to the host (or if it is lost) and you want to send an event.
+
+
+.. automodule:: ble_hid
+   :members:

Documentation/pycardium/bme680.rst

@@ -4,11 +4,50 @@
 =================================
 Allows access to environmental data of card10's surroundings.
 
+If ``bsec_enable`` is set in :ref:`card10_cfg`, the proprietary Bosch BSEC
+library will be activated which offers the following extra functionality:
+
+ - Manual temperature offset compensation
+    The ``bsec_offset`` configuration allows to configure a static temperature
+    offset. Please use a reference thermometer to determine the offset of your
+    card10. If no offset is provided a default offset for a card10 which is
+    connected to USB, has BLE active and is without a case is used.
+ - A fixed measurement interval of 3 seconds
+    This helps to stabilize the temperature of the card10.
+ - An indoor air quality (IAQ)  and equivalent CO2 estimation algorithm
+    Please refer to the :ref:`bsec_api` API documentation to get more information
+    about how to interpret these estimates.
+
+.. note::
+   Please keep in mind that the BME680 can not directly measure CO2. It measures
+   Volatile Organic Compounds (VOCs). The BSEC library uses this measurement
+   to compute an Indoor Air Quality (IAQ) indication. It also assumes that all VOCs
+   in the air are from human breath and computes an equivalent CO2 (eCO2)
+   value from this. Please be aware of these facts when judging the accuracy
+   of the IAQ and eCO2 values. Some more information can be found in the
+   :ref:`bsec_api` API documentation.
+
+.. warning::
+   For the BSEC library to properly work the card10 should be kept running
+   for at least 10 hours at least once. This is needed as the BSEC library
+   periodically writes calibration information about the sensor to the
+   card10's file system.
+
+   Please make sure to observe the IAQ accuracy field. It will tell you if the
+   IAQ and eCO2 measurements are deemed "accurate" by the BSEC library. Your
+   application should either inform the user about the current accuracy (e.g.
+   by color coding) or simply not show any values if the accuracy is below 2.
+
+
+.. note::
+   See also the BLE :ref:`ESS`.
+
+
 **Example**:
 
 .. code-block:: python
 
-   import bme680, utime
+   import bme680, time
 
    with bme680.Bme680() as environment:
        while True:
@@ -19,7 +58,15 @@ Allows access to environmental data of card10's surroundings.
            print("Pressure:       {:10.2f} hPa".format(d.pressure))
            print("Gas Resistance: {:10.2f} Ω".format(d.resistance))
 
-           utime.sleep(1)
+           time.sleep(1)
+
+You can use the return type of :py:meth:`~bme680.Bme680.get_data` to decide
+if you want to use/display the additonal fields returned if BSEC is enabled.
+
+.. code-block:: python
+
+    if isinstance(d, bme680.BSECData):
+        print("Air quality:    {:7d}".format(d.iaq))
 
 Sensor Class
 ------------

Documentation/pycardium/color.rst

@@ -14,23 +14,65 @@ The color module also contains a few constanst for commonly used colors:
 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
@@ -39,142 +81,561 @@ 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/max86150.rst

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

Documentation/pycardium/os.rst

@@ -8,12 +8,6 @@ functions found in CPythons ``os`` module.
 CPython-Like
 ------------
 
-.. py:function:: unlink(path)
-
-   Unlink (remove) a file.
-
-   :param str path: The file to remove.
-
 .. py:function:: listdir(dir)
 
    List contents of a directory.
@@ -22,6 +16,28 @@ CPython-Like
    :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.
@@ -99,3 +115,17 @@ Card10-Specific
 .. 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/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/stdlib.rst

 MicroPython Standard Library
 ============================
-Pycardium contains some modules from the MicroPython standard library.  These
-are:
+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
 
@@ -219,7 +237,7 @@ Struct module.
 
       UUID version accordiung to RFC 4122
 
-.. py:function:: uuid4():
+.. py:function:: uuid4()
 
    Generate a new UUID version 4 (random UUID).
 

Documentation/pycardium/utime.rst

@@ -8,6 +8,9 @@ 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
 
@@ -45,6 +48,36 @@ alarm.
 
    .. 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
@@ -54,6 +87,13 @@ alarm.
       :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.
@@ -61,6 +101,12 @@ alarm.
    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
@@ -92,13 +138,13 @@ alarm.
 
    .. code-block:: python
 
-      import utime
+      import time
 
       def minute_timer(x):
-         current = utime.time()
+         current = time.time()
          print("Current: " + str(current))
          alarm = (current // 60 + 1) * 60
-         utime.alarm(alarm, minute_timer)
+         time.alarm(alarm, minute_timer)
 
       minute_timer(None)
 
@@ -107,13 +153,13 @@ alarm.
 
    .. code-block:: python
 
-      import interrupt, utime
+      import interrupt, time
 
       def 5_second_timer(x):
-         current = utime.time()
+         current = time.time()
          print("Current: " + str(current))
          alarm = (current // 10) * 10 + 5
-         utime.alarm(alarm)
+         time.alarm(alarm)
 
       # This time, we need to register and enable the callback manually
       interrupt.set_callback(interrupt.RTC_ALARM, 5_second_timer)

Documentation/pycardium/ws2812.rst

@@ -19,7 +19,9 @@ The ``ws2812`` module controls LEDs of the WS2812 type. Just as the ``leds`` mod
 
    .. code-block:: python
 
-      import color, utime, ws2812, gpio
+      import color, time, ws2812, gpio
+
+      gpio.set_mode(gpio.WRISTBAND_2, gpio.mode.OUTPUT)
 
       i = 0
       while True:
@@ -28,6 +30,6 @@ The ``ws2812`` module controls LEDs of the WS2812 type. Just as the ``leds`` mod
           col3 = color.from_hsv((i + 40) % 360, 1.0, 0.1)
           ws2812.set_all(gpio.WRISTBAND_2, [col1, col2, col3])
           i += 1
-          utime.sleep_ms(10)
+          time.sleep_ms(10)
 
    .. versionadded:: 1.10

bootloader/bootloader-display.c

@@ -8,13 +8,12 @@
 
 static void bootloader_display_splash(void)
 {
-	gfx_copy_region(
+	gfx_copy_region_rle_mono(
 		&display_screen,
 		0,
 		0,
 		160,
 		80,
-		GFX_RLE_MONO,
 		sizeof(splash),
 		(const void *)(splash)
 	);