From 7a4c5264d43a9e1df90749ec0a8e19ab09f7f2b4 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Mon, 22 Jul 2019 17:17:14 +0200
Subject: [PATCH] docs: Mention API & BHI160
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/epicardium-guide.rst | 2 ++
Documentation/overview.rst | 10 ++++++++++
2 files changed, 12 insertions(+)
diff --git a/Documentation/epicardium-guide.rst b/Documentation/epicardium-guide.rst
index fd6d54f1..7a549214 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 e9708c92..9025c1a7 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
--
GitLab