2016-12-20 14:20:08 -05:00
|
|
|
Adafruit CircuitPython API Reference
|
2017-09-02 09:30:29 -04:00
|
|
|
====================================
|
2016-10-18 20:42:47 -04:00
|
|
|
|
2017-01-06 13:59:20 -05:00
|
|
|
.. 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
|
|
|
|
|
|
2017-07-03 18:05:08 -04:00
|
|
|
.. image :: https://img.shields.io/discord/327254708534116352.svg
|
|
|
|
|
:target: https://adafru.it/discord
|
|
|
|
|
:alt: Discord
|
|
|
|
|
|
2017-09-02 09:30:29 -04:00
|
|
|
Welcome to the API reference documentation for Adafruit CircuitPython.
|
|
|
|
|
This contains low-level API docs, and these docs 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 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
|
|
|
|
|
of that work with CircuitPython.
|
|
|
|
|
|
|
|
|
|
What boards use CircuitPython?
|
|
|
|
|
------------------------------
|
2017-05-24 14:44:23 -04:00
|
|
|
|
|
|
|
|
The Adafruit Express line of boards are specifically
|
2017-09-02 09:30:29 -04:00
|
|
|
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>`_
|
|
|
|
|
* `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>`_
|
|
|
|
|
* `Adafruit Feather M0 Bluefruit LE <https://www.adafruit.com/products/2995>`_
|
|
|
|
|
|
|
|
|
|
.. _contents:
|
|
|
|
|
|
|
|
|
|
Full Table of Contents
|
|
|
|
|
----------------------
|
2016-10-18 20:42:47 -04:00
|
|
|
|
|
|
|
|
.. toctree::
|
2017-06-07 15:00:15 -04:00
|
|
|
:maxdepth: 3
|
2017-09-02 09:30:29 -04:00
|
|
|
:caption: API and Usage
|
2016-10-18 20:42:47 -04:00
|
|
|
|
|
|
|
|
shared-bindings/index.rst
|
2017-08-31 17:52:02 -04:00
|
|
|
docs/supported_ports.rst
|
|
|
|
|
docs/troubleshooting.rst
|
2017-05-24 14:44:23 -04:00
|
|
|
docs/drivers.rst
|
2017-09-02 09:30:29 -04:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 3
|
|
|
|
|
:caption: Developer reference
|
|
|
|
|
|
2017-02-02 18:15:27 -05:00
|
|
|
docs/design_guide
|
2017-08-31 17:52:02 -04:00
|
|
|
docs/common_hal
|
2016-10-18 20:42:47 -04:00
|
|
|
docs/library/index.rst
|
2017-09-02 09:30:29 -04:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 3
|
|
|
|
|
:caption: About the project
|
|
|
|
|
|
2016-10-19 13:22:31 -04:00
|
|
|
README
|
|
|
|
|
CONTRIBUTING
|
|
|
|
|
CODE_OF_CONDUCT
|
2016-10-18 20:42:47 -04:00
|
|
|
license.rst
|
|
|
|
|
|
|
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
* :ref:`modindex`
|
|
|
|
|
* :ref:`search`
|
