No description
Find a file
Scott Shawcroft 411190f58a
Init OK on 2.1.0
LIS3DH doesn't have `set_tap` on 2.1.0.
2017-12-16 21:54:56 -08:00
_static Added ability to change touch threshold 2017-12-10 00:59:20 -05:00
adafruit_circuitplayground Init OK on 2.1.0 2017-12-16 21:54:56 -08:00
.gitignore Update to new build process and add lint. 2017-12-06 11:47:25 -08:00
.pylintrc Update to new build process and add lint. 2017-12-06 11:47:25 -08:00
.travis.yml Update to new build process and add lint. 2017-12-06 11:47:25 -08:00
CODE_OF_CONDUCT.md First version that has a subset of functionality. 2017-08-01 16:34:41 -07:00
conf.py Acceleration implemented. (#11) 2017-10-12 14:28:35 -07:00
LICENSE First version that has a subset of functionality. 2017-08-01 16:34:41 -07:00
README.rst Update added to readme 2017-10-08 21:15:47 -06:00
readthedocs.yml Update to new build process and add lint. 2017-12-06 11:47:25 -08:00
requirements.txt First version that has a subset of functionality. 2017-08-01 16:34:41 -07:00

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-circuitplayground/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/circuitplayground/en/latest/
    :alt: Documentation 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

.. image :: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord

This high level library provides objects that represent CircuitPlayground hardware.

.. image :: /_static/circuitplayground_express.jpg
    :target: https://adafruit.com/product/3333
    :alt: CircuitPlayground Express

Installation
=============
This driver depends on many other libraries! Please install it by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Usage Example
=============
Using it is super simple. Simply import the `cpx` variable from the module
and then use it.

.. code-block :: python

    from adafruit_circuitplayground.express import cpx

    while True:
        if cpx.button_a:
            print("Temperature:", cpx.temperature)
        cpx.red_led = cpx.button_b

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_CircuitPlayground/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

API Reference
=============

.. toctree::
    :maxdepth: 2

    adafruit_circuitplayground/index