https://github.com/adafruit/adafruit_circuitpython_minimqtt

MQTT Client Library for CircuitPython
https://github.com/adafruit/adafruit_circuitpython_minimqtt

circuitpython hacktoberfest mqtt mqtt-client

Last synced: 29 days ago
JSON representation

MQTT Client Library for CircuitPython

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_minimqtt
• Owner: adafruit
• License: other
• Created: 2019-06-27T16:10:40.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-09T13:42:17.000Z (about 2 months ago)
• Last Synced: 2024-10-07T10:55:52.482Z (29 days ago)
• Topics: circuitpython, hacktoberfest, mqtt, mqtt-client
• Language: Python
• Homepage:
• Size: 582 KB
• Stars: 80
• Watchers: 23
• Forks: 50
• Open Issues: 26
• 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/adafruit-circuitpython-minimqtt/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/minimqtt/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_MiniMQTT/workflows/Build%20CI/badge.svg

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

    :alt: Build Status

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json

    :target: https://github.com/astral-sh/ruff

    :alt: Code Style: Ruff

MQTT Client library for CircuitPython.

Dependencies

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

This driver depends on:

* `Adafruit CircuitPython `_

* `Adafruit CircuitPython ConnectionManager `_

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-minimqtt

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-minimqtt

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-minimqtt

Usage Example

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

Please check the `examples folder `_

for usage examples for this library.

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.