index.rst 1.69 KB
Newer Older
Rahix's avatar
Rahix committed
1
2
3
card10 firmware docs
====================

Rahix's avatar
Rahix committed
4
**Dear traveller,**
Rahix's avatar
Rahix committed
5

Rahix's avatar
Rahix committed
6
7
8
these transcripts describe how you can write code for your card10.  This
includes the Python modules that are available but also documentation of the
lower level firmware components.
Rahix's avatar
Rahix committed
9

Rahix's avatar
Rahix committed
10
If you want to write Python code for card10, you will want to take a look at
Rahix's avatar
Rahix committed
11
the :ref:`Pycardium <pycardium_overview>` docs.  If you are interested in writing applications
Rahix's avatar
Rahix committed
12
in other languages, you'll probably want to interface with
Rahix's avatar
Rahix committed
13
:ref:`Epicardium API <epicardium_api_overview>` directly.
Rahix's avatar
Rahix committed
14

Rahix's avatar
Rahix committed
15
Last but not least, if you want to start hacking the lower-level firmware, the
Rahix's avatar
Rahix committed
16
:ref:`Firmware <firmware_overview>` section of these docs is a good starting place.
Rahix's avatar
Rahix committed
17

Rahix's avatar
Rahix committed
18
19

.. toctree::
Rahix's avatar
Rahix committed
20
   :maxdepth: 1
Rahix's avatar
Rahix committed
21
22
   :caption: Pycardium

Rahix's avatar
Rahix committed
23
   pycardium/overview
24
   pycardium/stdlib
koalo's avatar
koalo committed
25
   pycardium/bhi160
Rahix's avatar
Rahix committed
26
   pycardium/bme680
schneider's avatar
schneider committed
27
   pycardium/max30001
Rahix's avatar
Rahix committed
28
   pycardium/buttons
Rahix's avatar
Rahix committed
29
   pycardium/color
schneider's avatar
schneider committed
30
   pycardium/config
Rahix's avatar
Rahix committed
31
   pycardium/display
32
   pycardium/gpio
Rahix's avatar
Rahix committed
33
   pycardium/leds
Rahix's avatar
Rahix committed
34
   pycardium/light-sensor
Rahix's avatar
Rahix committed
35
   pycardium/os
36
   pycardium/personal_state
Rahix's avatar
Rahix committed
37
   pycardium/power
koalo's avatar
koalo committed
38
   pycardium/pride
Rahix's avatar
Rahix committed
39
   pycardium/simple_menu
Rahix's avatar
Rahix committed
40
   pycardium/utime
Rahix's avatar
Rahix committed
41
   pycardium/vibra
danb's avatar
danb committed
42
   pycardium/ws2812
Rahix's avatar
Rahix committed
43
44
45
46
47
48

.. toctree::
   :maxdepth: 1
   :caption: Firmware

   overview
49
50
   card10-cfg
   usb-file-transfer
Rahix's avatar
Rahix committed
51
52
53
   how-to-build
   how-to-flash
   debugger
Rahix's avatar
Rahix committed
54
   pycardium-guide
schneider's avatar
schneider committed
55
   memorymap
56
   epicardium/mutex
Rahix's avatar
Rahix committed
57
   epicardium/sensor-streams
schneider's avatar
schneider committed
58
59
60
61
62
63
64
65

.. toctree::
   :maxdepth: 1
   :caption: Epicardium API

   epicardium/overview
   epicardium/api
   epicardium-guide
66

67
68
69
70
71
.. toctree::
   :maxdepth: 1
   :caption: Bluetooth

   bluetooth/file-transfer
genofire's avatar
genofire committed
72
   bluetooth/card10
coon's avatar
coon committed
73
   bluetooth/nimble
74

75
76
77
78
79
80
Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`