Introduction

Documentation Status Discord Build Status Code Style: Black

Amazon AWS IoT MQTT Client for CircuitPython.

Note: This library requires version >=1.4.0 of the Adafruit fork of the Arduino NINA-W102 firmware

installed on your ESP32 Airlift/WiFi Co-Processor.

If you do not know how to do this, visit the Adafruit Learning System guide for this topic…

Dependencies

This driver depends on:

Please ensure 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-aws-iot

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

sudo pip3 install adafruit-circuitpython-aws-iot

To install in a virtual environment in your current project:

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

Usage Example

Library examples within examples/ folder.

Documentation

API documentation for this library can be found on Read the Docs.

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

Contributing

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

Table of Contents

Examples

Indices and tables