You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

93 lines
2.7 KiB

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
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
Welcome to the API reference documentation for Adafruit CircuitPython.
This contains low-level API reference docs which may link out to separate
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
excellent tutorials available through the
`Adafruit Learning System <https://learn.adafruit.com/>`_.
What is CircuitPython?
----------------------
**CircuitPython** is an *education friendly* open source derivative of
`MicroPython <https://micropython.org>`_. CircuitPython supports 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 Adafruit libraries and drivers of
that work with it.
What boards use CircuitPython?
------------------------------
The Adafruit Express line of boards is specifically
designed for use with CircuitPython. This line includes:
`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:
`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>`_.
.. _contents:
Full Table of Contents
----------------------
.. toctree::
:maxdepth: 3
:caption: API and Usage
shared-bindings/index.rst
docs/supported_ports.rst
docs/troubleshooting.rst
docs/drivers.rst
.. toctree::
:maxdepth: 1
:caption: Design and porting reference
docs/design_guide
docs/common_hal
.. toctree::
:maxdepth: 2
:caption: MicroPython specific
docs/library/index.rst
.. toctree::
:maxdepth: 1
:caption: About the project
README
CONTRIBUTING
CODE_OF_CONDUCT
license.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`