adafruit / adafruit_circuitpython_aws_iot

Amazon AWS IoT MQTT Client for CircuitPython

Introduction

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:

• Adafruit CircuitPython
• Adafruit CircuitPython ConnectionManager
• Adafruit CircuitPython MiniMQTT

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.

adafruit_circuitpython_aws_iot's Issues

Imprort of MMQTTException is wrong

Should be
from adafruit_minimqtt.adafruit_minimqtt import MMQTTException
Not
from adafruit_minimqtt import MMQTTException

Missing Type Annotations

There are missing type annotations for some functions in this library.

The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:

try:
    from typing import List, Tuple
except ImportError:
    pass

Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:

def wrap_text_to_pixels(
    string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:

If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github

There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.

If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.

The following locations are reported by mypy to be missing type annotations:

• adafruit_aws_iot.py:49
• adafruit_aws_iot.py:94
• adafruit_aws_iot.py:124
• adafruit_aws_iot.py:137
• adafruit_aws_iot.py:151
• adafruit_aws_iot.py:165
• adafruit_aws_iot.py:176
• adafruit_aws_iot.py:189
• adafruit_aws_iot.py:219
• adafruit_aws_iot.py:230
• adafruit_aws_iot.py:240
• adafruit_aws_iot.py:258
• adafruit_aws_iot.py:265
• adafruit_aws_iot.py:272

"Invalid broker address defined" error

I'm getting this error. I have log set to true, all credentials and secrets parameters are correct, Adafruit PyPortal on version 5 firmware with the latest bundle, esp firmware version 1.6.0.

I also confirmed the minimqtt and AWS IoT libraries are both at the latest version. I'm using the simpletest example. I tried setting ssl to false as suggested by brentru and that didn't work either.

Traceback (most recent call last):
File "code.py", line 148, in
File "adafruit_aws_iot.py", line 155, in connect
File "adafruit_aws_iot.py", line 155, in connect
AWS_IOT_ERROR: ('Error connecting to AWS IoT: ', MMQTTException('Invalid broker address defined.', RuntimeError('ESP32 not responding',)))

Support for ESP32 Direct Boards

Any plan to support the ESP32 direct boards, for example the ESP-32 S3 TFT Reverse board.

See discussion here:
https://forums.adafruit.com/viewtopic.php?p=966126#p966126

RootCA missing?

Looked through the code, couldnt find where the Root Certificate Authority is being set.

I have intermittent connection issues. Sometimes I have to reload the code several times to get it to connect. Wondering if its related..

AWS IoT SDK Python V2 Support

Are there any plans to support version 2 of the AWS IoT SDK for Python? Version 1 of the SDK is not being updated regularly anymore.

I asked this question on the Adafruit support forum because I want to run version 2 of the SDK on the Raspberry Pi Pico W.

(https://forums.adafruit.com/viewtopic.php?t=195661&e=1&view=unread#unread)

(https://github.com/aws/aws-iot-device-sdk-python-v2)

RTD Documentation: Build status not successful

The RTD documentation was determined not to have built successfully. This could be the result of one of two reasons:

1. The documentation truly had an error occur and failed to build
2. The badge icon and/or link is not correctly formatted or pointing to the correct RTD link

AWS_IOT_ERROR ('Error Connection to AWS IoT: ', MQTTException('Repeated connect failures',))

Hello,
5 months ago, I had build a demo reusing the code in the PyPortal IoT Plant Monitor with AWS IoT and CircuitPython which I had modified.
Everything was working fine.
I was trying to recreate this demo and now the Adafruit Pyportal is not able to connect to AWS IoT. Even when trying to recreate the PyPortal IoT Plant Monitor with AWS IoT and CircuitPython demo instead of my modified demo it fails with the same error:

File "adafruit_aws_iot.py", line 145, in connect
AWS_IOT_ERROR: ('Error connecting to AWS IoT: ', MMQTTException('Repeated connect failures',))

Could it be because of this issue AWS IoT SDK Python V2 Support

Thank you in advance