Initial Pull Request

[brentru]

Initial pull request for MiniMQTT - a featured MQTT client for CircuitPython

This library is based off previous work performed by pfalcon on the uMQTT library (and the subsequent port to ESP32SPI by beachbc) and follows similar callback conventions and method signatures from the Eclipse Foundation's Paho.Mqtt.Python.

MiniMQTT API Overview

• connect: initiates a connection with the mqtt broker

• reconnect: handles reconnection to the mqtt broker and re-subscription to topics

• last_will: Sets the client's optional last will and testament properties

• publish: Publishes to a broker's mqtt topic. Handles data type conversions.

• subscribe: Subscribes to a broker's mqtt topic. Can subscribe to one, or multiple topics with varying QoS levels.

• unsubscribe: Unsubscribes from a broker's mqtt topic or multiple topics.

• loop: Non-blocking messaging loop, useful for checking incoming subscription messages.

• loop_forever: Blocking messaging loop

• set_logger_level/log: Attaches/modifies a logger to the MiniMQTT client

[abachman]

I notice there are a lot of normal commands that can result in errors being raised, specifically related to is_connected.

The examples should either use try: except: around every call or it might be worth figuring out a different way to address unexpected disconnection.

[brentru]

A method of addressing this unexpected disconnection might be passing each command method (publish, subscribe) to a high level method which checks the connection status and handles hardware and network reconnections. Though this does add overhead - it might be nicer than wrapping each publish/subscribe call in a try/except loop?

…

On Thu, Jul 11, 2019 at 5:34 PM Adam Bachman ***@***.***> wrote: I notice there are a lot of normal commands that can result in errors being raised, specifically related to is_connected. The examples should either use try: except: around every call or it might be worth figuring out a different way to address unexpected disconnection. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#1?email_source=notifications&email_token=AACOW7BUQQOKVNFB4IWP74DP66RNNA5CNFSM4IAAMC3KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZYBPTQ#issuecomment-510662606>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AACOW7A7SNJVOX5NCPASQCDP66RNNANCNFSM4IAAMC3A> .

[abachman]

Are you strongly attached to "MiniMQTT", or would "MQTT" be okay?

Also, is it possible to make the name of the repository the same as the name of the module?

[ladyada]

chagne 'while 1' to 'while true:' and get rid of the const()'s

[brentru]

@abachman MQTT would not be OK as ReadTheDocs requires a non-generic slug url (i.e: https://readthedocs.org/projects/mqtt/ is already taken).

[ladyada]

i think this is good for an initial version, and we'll see how it goes!

[tannewt]

Shouldn't the readthedocs slug be adafruit-circuitpython-mqtt (or adafruit-circuitpython-minimqtt)? It's only as a circuitpython subproject that it's shortened to mqtt or minimqtt.

[brentru]

@tannewt Yep, just redid the RTD setup to use that slug. RTD badge on README is now green.

[tannewt]

Perfect! Glad it helped.