https://github.com/adafruit/adafruit_circuitpython_aws_iot

Amazon AWS IoT MQTT Client for CircuitPython
https://github.com/adafruit/adafruit_circuitpython_aws_iot

aws-iot hacktoberfest mqtt

Last synced: 2 days ago
JSON representation

Amazon AWS IoT MQTT Client for CircuitPython

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_aws_iot
• Owner: adafruit
• License: mit
• Created: 2019-10-09T17:39:33.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T22:24:01.000Z (3 months ago)
• Last Synced: 2024-12-24T01:19:50.130Z (5 days ago)
• Topics: aws-iot, hacktoberfest, mqtt
• Language: Python
• Size: 126 KB
• Stars: 14
• Watchers: 22
• Forks: 11
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/circuitpython-aws-iot/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/aws_iot/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_AWS_IOT/actions/

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: 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:

* `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:

.. code-block:: shell

    pip3 install adafruit-circuitpython-aws-iot

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-aws-iot

To install in a virtual environment in your current project:

.. code-block:: shell

    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.