diff --git a/Documentation/epicardium-guide.rst b/Documentation/epicardium-guide.rst index fd6d54f11659f24c852017f02d6404f50f7a3380..7a549214442083b5a033b25ac84331fbda1a470f 100644 --- a/Documentation/epicardium-guide.rst +++ b/Documentation/epicardium-guide.rst @@ -1,3 +1,5 @@ +.. _epicardium_api_guide: + Epicardium API Development ========================== If you are interested in augmenting the Epicardium API with new calls, this diff --git a/Documentation/overview.rst b/Documentation/overview.rst index e9708c9277e9a9358cd4f4c5dee86540fd532ab5..9025c1a76134e1f75d55351dc17f44de9badb868 100644 --- a/Documentation/overview.rst +++ b/Documentation/overview.rst @@ -19,6 +19,9 @@ number of tasks that will have been keeping card10 running. These are: statistics that can be gathered from our power manager IC (MAX77650). * **Serial**: Handles serial communication via *UART*, *CDC ACM* and possibly Bluetooth. +* **BHI160**: Housekeeping task for interaction with the `BHI160`_. + +.. _BHI160: https://www.bosch-sensortec.com/bst/products/all_products/bhi160 .. todo:: @@ -29,6 +32,13 @@ number of tasks that will have been keeping card10 running. These are: .. _#23: https://git.card10.badge.events.ccc.de/card10/firmware/issues/23 +Epicardium API +-------------- +Epicardium exposes lots of functionality via the *Epicardium API*. The +technical details if this API can be found in this :ref:`overview +<epicardium_api_overview>`. If you are interesting in adding new API calls, +you should probably read the :ref:`epicardium_api_guide` guide. + Pycardium --------- Pycardium is our MicroPython fork. Its purpose is to make it as easy as