djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/drivers.rst

55 lines
2.5 KiB
ReStructuredText
Raw Normal View History

Update more docs to say CircuitPython and clarify driver support.
2017-01-05 19:32:33 -05:00
Adafruit CircuitPython drivers
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
========================================
Update more docs to say CircuitPython and clarify driver support.
2017-01-05 19:32:33 -05:00
These are drivers available in separate GitHub repos. They are designed for use
with CircuitPython and may or may not work with `MicroPython <https://micropython.org>`_.
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
Add more description of installing the library bundle.
2017-01-13 20:00:26 -05:00
.. _bundle_installation:
Add more detail to the driver page including a link to the bundle.
2017-01-06 16:18:40 -05:00
Bundle
------
We provide a bundle of all our libraries to ease installation of drivers and
Add more description of installing the library bundle.
2017-01-13 20:00:26 -05:00
their dependencies. he bundle is primarily geared to the Adafruit Express line
of boards which will feature a relatively large external flash. With Express
boards, its easy to copy them all onto the filesystem. However, if you don't
have enough space simply copy things over as they are needed.
Add more detail to the driver page including a link to the bundle.
2017-01-06 16:18:40 -05:00
The bundles are available `on GitHub <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_.
Add more description of installing the library bundle.
2017-01-13 20:00:26 -05:00
To install them:
#. `Download <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases>`_ and unzip the latest zip thats not a source zip.
#. Copy the ``lib`` folder to the ``CIRCUIPY`` or ``MICROPYTHON``.
Add more detail to the driver page including a link to the bundle.
2017-01-06 16:18:40 -05:00
Foundational Libraries
----------------------
These libraries provide critical functionality to many of the drivers below. It
is recommended to always have them installed onto the CircuitPython file system in
the ``lib/`` directory. Some drivers may not work without them.
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
.. toctree::
Improve docs and update to CircuitPython.
2017-01-05 19:20:46 -05:00
Register Library <https://circuitpython.readthedocs.io/projects/register/en/latest/>
Link to the Bus Device docs.
2017-01-05 21:43:22 -05:00
BusDevice Library <https://circuitpython.readthedocs.io/projects/bus_device/en/latest/>
Add more detail to the driver page including a link to the bundle.
2017-01-06 16:18:40 -05:00
Drivers
-------
Drivers provide easy access to sensors and other chips without requiring a
knowledge of the interface details of the chip itself.
.. toctree::
Update drivers.rst
2016-10-20 12:58:46 -04:00
RGB Displays <http://micropython-rgb.readthedocs.io/>
Documentation rework to unify the docs together rather than having them on a per port basis. Also enables generating docs from inline RST in C code. Simply omits all lines except those that start with //|. Indentation after "//| " will be preserved.
2016-10-18 20:42:47 -04:00
Analog-to-digital converters: ADS1015 and ADS1115 <http://micropython-ads1015.readthedocs.io/>
Use full link because relative links don't work.
2017-01-04 14:27:36 -05:00
DS3231 Real-time Clock (Precision RTC) <https://circuitpython.readthedocs.io/projects/ds3231/en/latest/>
docs: Add link to DS1307 drivers.
2017-01-09 19:34:23 -05:00
DS1307 Real-time Clock (5V RTC Breakout) <https://circuitpython.readthedocs.io/projects/ds1307/en/latest/>
Use full link because relative links don't work.
2017-01-04 14:27:36 -05:00
PCF8523 Real-time Clock (Adalogger RTC) <https://circuitpython.readthedocs.io/projects/pcf8523/en/latest/>
Update drivers.rst
2016-10-20 12:58:46 -04:00
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/>