ccbb5e84f9
Docs are here: http://tannewt-micropython.readthedocs.io/en/microcontroller/ It differs from upstream's machine in the following ways: * Python API is identical across ports due to code structure. (Lives in shared-bindings) * Focuses on abstracting common functionality (AnalogIn) and not representing structure (ADC). * Documentation lives with code making it easy to ensure they match. * Pin is split into references (board.D13 and microcontroller.pin.PA17) and functionality (DigitalInOut). * All nativeio classes claim underlying hardware resources when inited on construction, support Context Managers (aka with statements) and have deinit methods which release the claimed hardware. * All constructors take pin references rather than peripheral ids. Its up to the implementation to find hardware or throw and exception.
42 lines
1.4 KiB
ReStructuredText
42 lines
1.4 KiB
ReStructuredText
Adafruit MicroPython API Reference
|
|
========================================
|
|
|
|
Welcome! This is the documentation for Adafruit MicroPython. 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>`_ including 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's MicroPython port features a unified Python APIs available under
|
|
`!shared-bindings` and a growing list of drivers that work with it. Currently
|
|
only the Atmel SAMD21 port is supported but ESP8266 support will be added in the
|
|
near future.
|
|
|
|
`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: 2
|
|
|
|
shared-bindings/index.rst
|
|
docs/common_hal
|
|
docs/drivers.rst
|
|
docs/supported_ports.rst
|
|
docs/unsupported_ports.rst
|
|
docs/library/index.rst
|
|
README
|
|
CONTRIBUTING
|
|
CODE_OF_CONDUCT
|
|
license.rst
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|