Skip to content
Adafruit IO for CircuitPython
Branch: master
Clone or download
ladyada Merge pull request #22 from brentru/update-simpletest
Update simpletest examples to detect boards with built-in ESP32
Latest commit ac455da Apr 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
adafruit_io remove text kwarg from GET since we're only expecting JSON responses now Mar 12, 2019
docs remove automock import from config, we dont need it anymore since wer… Feb 25, 2019
examples switch defs, one spi object, pylint Apr 30, 2019
.gitignore
.pylintrc add files from pyportal board Feb 19, 2019
.readthedocs.yml add files from pyportal board Feb 19, 2019
.travis.yml fix travis path Feb 22, 2019
CODE_OF_CONDUCT.md add files from pyportal board Feb 19, 2019
LICENSE
README.rst ADAFRUIT_IO_USERNAME/KEY -> aio_username/key Mar 11, 2019
requirements.txt add files from pyportal board Feb 19, 2019
setup.py update readme, setup, lib Feb 21, 2019

README.rst

Adafruit_CircuitPython_AdafruitIO

Documentation Status Discord Build Status

CircuitPython wrapper library for communicating with Adafruit IO.

Dependencies

This driver depends on:

You'll also need a library to communicate with an ESP32 as a coprocessor using a WiFiManager object. This library supports connecting an ESP32 using either SPI or UART.

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

Create an Adafruit IO Client object

io = RESTClient(aio_username, aio_key, wifi)

Sending data to an Adafruit IO feed

io.send_data(feed, data)

Receiving data from an Adafruit IO feed

data = io.receive_data(feed)

Creating a new feed named circuitpython with a description

feed = io.create_new_feed('circuitpython', 'an Adafruit IO CircuitPython feed')

Listing the record of a specified feed:

feed = io.get_feed('circuitpython')

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

Zip release files

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-adafruit_io --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.