Add a micropython section and edit drivers doc
This commit is contained in:
Carol Willing
Scott Shawcroft
parent
676a5b399e
commit
1f71851d3a
@ -1,5 +1,7 @@
|
||||
Additional Libraries on GitHub
|
||||
========================================
|
||||
.. _adafruit-libndrivers:
|
||||
|
||||
Additional Adafruit Libraries and Drivers on GitHub
|
||||
===================================================
|
||||
|
||||
These are libraries and drivers available in separate GitHub repos. They are
|
||||
designed for use with CircuitPython and may or may not work with
|
||||
@ -20,7 +22,8 @@ The bundles are available `on GitHub <https://github.com/adafruit/Adafruit_Circu
|
||||
|
||||
To install them:
|
||||
|
||||
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_ and unzip the latest zip thats not a source zip.
|
||||
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_
|
||||
and unzip the latest zip that's not a source zip.
|
||||
#. Copy the ``lib`` folder to the ``CIRCUITPY`` or ``MICROPYTHON``.
|
||||
|
||||
Foundational Libraries
|
||||
@ -32,16 +35,17 @@ the ``lib/`` directory. Some drivers may not work without them.
|
||||
|
||||
.. toctree::
|
||||
|
||||
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
|
||||
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
|
||||
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
|
||||
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
|
||||
|
||||
Helper Libraries
|
||||
-------
|
||||
----------------
|
||||
|
||||
These libraries build on top of the low level APIs to simplify common tasks.
|
||||
|
||||
.. toctree::
|
||||
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
|
||||
|
||||
USB Human Interface Device (Keyboard and Mouse) <https://circuitpython.readthedocs.io/projects/hid/en/latest/>
|
||||
|
||||
Drivers
|
||||
-------
|
||||
@ -50,17 +54,18 @@ Drivers provide easy access to sensors and other chips without requiring a
|
||||
knowledge of the interface details of the chip itself.
|
||||
|
||||
.. toctree::
|
||||
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
|
||||
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
|
||||
RGB Displays <http://micropython-rgb.readthedocs.io/>
|
||||
SD Card <https://circuitpython.readthedocs.io/projects/sdcard/en/latest/>
|
||||
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
|
||||
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
|
||||
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
|
||||
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
|
||||
TCS34725 Color Sensor <http://micropython-tcs34725.readthedocs.io/>
|
||||
TSL2561 Light Sensor <http://micropython-tsl2561.readthedocs.io/>
|
||||
PCA9685 Motor and Servo Controllers <http://micropython-pca9685.readthedocs.io/>
|
||||
HT16K33 LED Matrices and Segment Displays <http://micropython-ht16k33.readthedocs.io/>
|
||||
IS31FL3731 Charlieplexed LED Matrix <http://micropython-is31fl3731.readthedocs.io/>
|
||||
MAX7219 LED Matrix <http://micropython-max7219.readthedocs.io/>
|
||||
|
||||
NeoPixel <https://circuitpython.readthedocs.io/projects/neopixel/en/latest/>
|
||||
SimpleIO <https://circuitpython.readthedocs.io/projects/simpleio/en/latest/>
|
||||
RGB Displays <http://micropython-rgb.readthedocs.io/>
|
||||
SD Card <https://circuitpython.readthedocs.io/projects/sdcard/en/latest/>
|
||||
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
|
||||
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
|
||||
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
|
||||
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
|
||||
TCS34725 Color Sensor <http://micropython-tcs34725.readthedocs.io/>
|
||||
TSL2561 Light Sensor <http://micropython-tsl2561.readthedocs.io/>
|
||||
PCA9685 Motor and Servo Controllers <http://micropython-pca9685.readthedocs.io/>
|
||||
HT16K33 LED Matrices and Segment Displays <http://micropython-ht16k33.readthedocs.io/>
|
||||
IS31FL3731 Charlieplexed LED Matrix <http://micropython-is31fl3731.readthedocs.io/>
|
||||
MAX7219 LED Matrix <http://micropython-max7219.readthedocs.io/>
|
||||
|
||||
53
index.rst
53
index.rst
@ -18,7 +18,7 @@ Adafruit CircuitPython API Reference
|
||||
:alt: Discord
|
||||
|
||||
Welcome to the API reference documentation for Adafruit CircuitPython.
|
||||
This contains low-level API docs, and these docs may link out to separate
|
||||
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/>`_.
|
||||
@ -26,11 +26,11 @@ excellent tutorials available through the
|
||||
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.
|
||||
**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 drivers of that work with it.
|
||||
|
||||
What boards use CircuitPython?
|
||||
------------------------------
|
||||
@ -46,7 +46,7 @@ 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 HUZZAH <https://www.adafruit.com/products/2821>`_
|
||||
* `Adafruit Feather M0 Bluefruit LE <https://www.adafruit.com/products/2995>`_
|
||||
|
||||
.. _contents:
|
||||
@ -55,30 +55,35 @@ Full Table of Contents
|
||||
----------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: API and Usage
|
||||
:maxdepth: 3
|
||||
:caption: API and Usage
|
||||
|
||||
shared-bindings/index.rst
|
||||
docs/supported_ports.rst
|
||||
docs/troubleshooting.rst
|
||||
docs/drivers.rst
|
||||
shared-bindings/index.rst
|
||||
docs/supported_ports.rst
|
||||
docs/troubleshooting.rst
|
||||
docs/drivers.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: Developer reference
|
||||
:maxdepth: 3
|
||||
:caption: Developer reference
|
||||
|
||||
docs/design_guide
|
||||
docs/common_hal
|
||||
docs/library/index.rst
|
||||
docs/design_guide
|
||||
docs/common_hal
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: About the project
|
||||
:maxdepth: 3
|
||||
:caption: MicroPython specific docs
|
||||
|
||||
README
|
||||
CONTRIBUTING
|
||||
CODE_OF_CONDUCT
|
||||
license.rst
|
||||
docs/library/index.rst
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:caption: About the project
|
||||
|
||||
README
|
||||
CONTRIBUTING
|
||||
CODE_OF_CONDUCT
|
||||
license.rst
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
Loading…
Reference in New Issue
Block a user