/Adafruit_CircuitPython_AdafruitIO

Adafruit IO for CircuitPython

Primary LanguagePythonMIT LicenseMIT

Adafruit_CircuitPython_AdafruitIO

Documentation Status Discord Build Status

CircuitPython wrapper library for communicating with Adafruit IO.

Dependencies

This driver depends on:

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

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-adafruitio

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-adafruitio

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-adafruitio

Usage Example

Usage examples for the Adafruit IO HTTP API are within the examples/http folder.

Usage examples for the Adafruit IO MQTT API are within the examples/mqtt folder.

Contributing

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

Documentation

For information on building library documentation, please check out this guide.