Adafruit CircuitPython API Reference

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 has many excellent tutorials available through the Adafruit Learning System.

What is CircuitPython?

CircuitPython is an education friendly open source derivative of MicroPython. CircuitPython supports use on educational development boards designed and sold by Adafruit. 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; Feather M0 Express; and Metro M0 Express

Other supported boards include: Arduino Zero; Adafruit Feather M0 Basic; Adafruit Feather HUZZAH; and Adafruit Feather M0 Bluefruit LE.

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