aboutsummaryrefslogtreecommitdiffstats
path: root/source/libmaple.rst
blob: 0517f4462a95b8f3dcd0b2ff53884d50e9b9ae3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
.. highlight:: sh

.. _libmaple:

``libmaple``
============

LeafLabs' libmaple (`source code on GitHub
<https://github.com/leaflabs/libmaple>`_) is the library we have
developed for the `STM32 <http://www.st.com/stonline>`_ line of ARM
Cortex M3 microcontrollers.  Its high-level interfaces are
:ref:`largely compatible <arduino-compatibility>` with the AVR
libraries written for the `Arduino <http://arduino.cc>`_ and `Wiring
<http://wiring.org.co/>`_ development boards.

.. _libmaple-vs-wirish:

libmaple is split into two pieces: a lower level layer written in C,
which we call *libmaple proper* (in the `libmaple/
<https://github.com/leaflabs/libmaple/tree/master/libmaple>`_
directory of the source repository), and the Wiring-style C++ API
written on top of it, called *Wirish* (in `wirish/
<https://github.com/leaflabs/libmaple/tree/master/wirish>`_; the
wirish APIs are :ref:`summarized here <language>`, with an :ref:`index
here <language-index>`).

libmaple is bundled with the :ref:`Maple IDE <ide>`.  However, we
develop it separately, and :ref:`release it standalone
<unix-toolchain>` for advanced users who might chafe at the "sketch"
programming model of the IDE.

As always, :ref:`patches are welcome <libmaple-contributing>`.

**Contents:**

.. toctree::
   :maxdepth: 1

   libmaple/overview
   libmaple/apis
   libmaple/contributing
   libmaple/coding-standard