Verified Commit a3421de7 authored by Rahix's avatar Rahix
Browse files

doc: Improve link structure


Signed-off-by: Rahix's avatarRahix <rahix@rahix.de>
parent edd35de9
.. _epicardium_api_overview:
Overview
========
Epicardium, the "main" firmware running on core 0, exposes a lot of
......
......@@ -8,15 +8,14 @@ includes the Python modules that are available but also documentation of the
lower level firmware components.
If you want to write Python code for card10, you will want to take a look at
the :ref:`pycardium_index` docs. If you are interested in writing applications
the :ref:`Pycardium <pycardium_overview>` docs. If you are interested in writing applications
in other languages, you'll probably want to interface with
:ref:`epicardium_api_index` directly.
:ref:`Epicardium API <epicardium_api_overview>` directly.
Last but not least, if you want to start hacking the lower-level firmware, the
:ref:`firmware_index` section of these docs is a good starting place.
:ref:`Firmware <firmware_overview>` section of these docs is a good starting place.
.. _pycardium_index:
.. toctree::
:maxdepth: 1
:caption: Pycardium
......@@ -25,7 +24,6 @@ Last but not least, if you want to start hacking the lower-level firmware, the
pycardium/color
pycardium/leds
.. _epicardium_api_index:
.. toctree::
:maxdepth: 1
:caption: Epicardium API
......@@ -33,7 +31,6 @@ Last but not least, if you want to start hacking the lower-level firmware, the
epicardium/overview
epicardium/api
.. _firmware_index:
.. toctree::
:maxdepth: 1
:caption: Firmware
......
.. _firmware_overview:
Overview
========
To make the most of card10's dual-core processor, its firmware will have been
......@@ -9,8 +11,8 @@ this will have been *Pycardium*, our MicroPython port.
Epicardium
----------
Epicardium is based on `FreeRTOS`_. There are a number of tasks that will have
been keeping card10 running. These are:
Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_. There are a
number of tasks that will have been keeping card10 running. These are:
* **Dispatcher**: The dispatcher task handles API calls from core 1.
* **PMIC**: The power manager task checks the battery level and other interesting
......@@ -22,10 +24,10 @@ been keeping card10 running. These are:
The following tasks have not yet been implemented/are currently in the works:
- **Bluetooth**: The bluetooth stack
- **Bluetooth**: The bluetooth stack (`#23`_)
- **Payload Controller**: Control what is running on core 1
.. _FreeRTOS: https://www.freertos.org/
.. _#23: https://git.card10.badge.events.ccc.de/card10/firmware/issues/23
Pycardium
---------
......
.. _pycardium_overview:
Overview
========
Pycardium is what we call our MicroPython port for card10. For the most part,
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment