CircuitPython

Source code browser

Adafruit CircuitPython API Reference
========================================

.. image:: https://travis-ci.org/adafruit/circuitpython.svg?branch=master
    :target: https://travis-ci.org/adafruit/circuitpython
    :alt: Build Status

.. image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
    :target: http://circuitpython.readthedocs.io/
    :alt: Doc Status

.. image:: https://badges.gitter.im/adafruit/circuitpython.svg
    :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
    :alt: Gitter

Welcome! This is the documentation for Adafruit CircuitPython. It is an open
source derivative of `MicroPython <https://micropython.org>`_ for use on
educational development boards designed and sold by `Adafruit
<https://adafruit.com>`_. Adafruit CircuitPython features unified Python core
APIs and a growing list of drivers that work with it.

The Adafruit Express line of boards are specifically
designed for use with CircuitPython. They are the
`CircuitPlayground Express <https://www.adafruit.com/product/3333>`_,
`Feather M0 Express <https://www.adafruit.com/product/3403>`_,
and `Metro M0 Express <https://www.adafruit.com/product/3505>`_.
Other supported boards include the `Arduino Zero
<https://www.arduino.cc/en/Main/ArduinoBoardZero>`_, `Adafruit Feather M0 Basic
<https://www.adafruit.com/product/2772>`_, `Adafruit Feather HUZZAH
<https://www.adafruit.com/products/2821>`_ and `Adafruit Feather M0 Bluefruit LE
<https://www.adafruit.com/products/2995>`_.

`Adafruit <https://adafruit.com>`_ has many excellent tutorials available
through the `Adafruit Learning System <https://learn.adafruit.com/>`_. These
docs are low-level API docs and may link out to separate getting started guides.

.. toctree::
    :maxdepth: 3

    shared-bindings/index.rst
    docs/drivers.rst
    docs/common_hal
    docs/design_guide
    docs/supported_ports.rst
    docs/library/index.rst
    README
    CONTRIBUTING
    CODE_OF_CONDUCT
    license.rst

Indices and tables
==================

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